Package org.polkadot.types.codec

Class Enum

  • All Implemented Interfaces:
    Codec
    Direct Known Subclasses:
    Modules.StorageFunctionModifier, NewAccountOutcome, RewardDestination, VoteThreshold
    public class Enum
extends Base<java.lang.Number>
implements Codec
    A codec wrapper for an enum. Enums are encoded as a single byte, where the byte is a zero-indexed value. This class allows you to retrieve the value either by `toNumber()` exposing the actual raw index, or `toString()` returning a string representation (as provided as part of the constructor)

    • Field Summary

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

        raw

    • Constructor Summary

      Constructors 
      Constructor Description
      Enum​(java.util.List<java.lang.String> def, java.lang.Object value)  

    • Method Summary

      Modifier and Type Method Description
      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
      int getIndex()
      Returns the index for this value (equivalent to toNumber)
      boolean isEmpty()
      Checks if the value is an empty value (always false)
      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
      int 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

      • 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

        toU8a

    • Constructor Detail

      • Enum

        public Enum​(java.util.List<java.lang.String> def,
            java.lang.Object value)

    • Method Detail

      • getEncodedLength

        public int getEncodedLength()
        The length of the value when encoded as a Uint8Array
        Specified by:
        getEncodedLength in interface Codec

      • getIndex

        public int getIndex()
        Returns the index for this value (equivalent to toNumber)

      • isEmpty

        public boolean isEmpty()
        Checks if the value is an empty value (always false)
        Specified by:
        isEmpty in interface Codec

      • 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 int 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)