org.polkadot.types.codec

Class Compact

java.lang.Object

org.polkadot.types.codec.Base<Compactable>

org.polkadot.types.codec.Compact

All Implemented Interfaces:

Codec

Direct Known Subclasses:

NonceCompact

public class Compact
extends Base<Compactable>
implements Codec

Compact A compact length-encoding codec wrapper. It performs the same function as Length, however differs in that it uses a variable number of bytes to do the actual encoding. This is mostly used by other types to add length-prefixed encoding, or in the case of wrapped types, taking a number and making the compact representation thereof

Field Summary

Fields inherited from class org.polkadot.types.codec.Base

raw

Constructor Summary

Constructors

Constructor and Description
Compact(Types.ConstructorCodec<? extends Compactable> type, java.lang.Object value)

Method Summary

Modifier and Type	Method and Description
int	bitLength() Returns the number of bits in the value
boolean	eq(java.lang.Object other) Compares the value of the input to see if there is a match
int	getEncodedLength() The length of the value when encoded as a Uint8Array
boolean	isEmpty() Checks if the value is an empty value
java.math.BigInteger	toBn() Returns the BN representation of the number
java.lang.String	toHex() Returns a hex string representation of the value
java.lang.Object	toJson() Converts the Object to JSON, typically used for RPC transfers
long	toNumber() Returns the number representation for the value
java.lang.String	toString() Returns the string representation of the value
byte[]	toU8a(boolean isBare) Encodes the value as a Uint8Array as per the parity-codec specifications
static Types.ConstructorCodec<Compact>	with(Types.ConstructorCodec<? extends Compactable> type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.polkadot.types.Codec

getConstructorCodec, toU8a

Constructor Detail

Compact

public Compact(Types.ConstructorCodec<? extends Compactable> type,
               java.lang.Object value)

Method Detail

with

public static Types.ConstructorCodec<Compact> with(Types.ConstructorCodec<? extends Compactable> type)

toBn

public java.math.BigInteger toBn()

Returns the BN representation of the number

getEncodedLength

public int getEncodedLength()

The length of the value when encoded as a Uint8Array

Specified by:

getEncodedLength in interface Codec

isEmpty

public boolean isEmpty()

Checks if the value is an empty value

Specified by:

isEmpty in interface Codec

bitLength

public int bitLength()

Returns the number of bits in the value

eq

public boolean eq(java.lang.Object other)

Compares the value of the input to see if there is a match

Specified by:

eq in interface Codec

toHex

public java.lang.String toHex()

Returns a hex string representation of the value

Specified by:

toHex in interface Codec

toJson

public java.lang.Object toJson()

Converts the Object to JSON, typically used for RPC transfers

Specified by:

toJson in interface Codec

toNumber

public long toNumber()

Returns the number representation for the value

toString

public java.lang.String toString()

Returns the string representation of the value

Overrides:

toString in class java.lang.Object

toU8a

public byte[] toU8a(boolean isBare)

Encodes the value as a Uint8Array as per the parity-codec specifications

Specified by:

toU8a in interface Codec

Parameters:

isBare - true when the value has none of the type-specific prefixes (internal)