com.casper.sdk.types

Enum CLType

java.lang.Object

java.lang.Enum<CLType>

com.casper.sdk.types.CLType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CLType>

public enum CLType
extends java.lang.Enum<CLType>

Type: enumeration over set of low level CL types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Indicates the type is not known
BOOL boolean primitive
BYTE_ARRAY Byte array prefixed with U32 length (FixedList)
I32 signed 32-bit integer primitive
I64 signed 64-bit integer primitive
KEY global state key
LIST List of values of the given type (e.g.
MAP Map(CLType, CLType), // key-value association where keys and values have the given types
OPTION optional value of the given type Option(CLType)
PUBLIC_KEY NO DEF IN SPEC https://docs.casperlabs.io/en/latest/implementation/serialization-standard.html
RESULT co-product of the the given types; one variant meaning success, the other failure
STRING e.g.
TUPLE_1 Tuple1(CLType) single value of the given type
TUPLE_2 Tuple2(CLType, CLType), // pair consisting of elements of the given types
TUPLE_3 Tuple3(CLType, CLType, CLType), // triple consisting of elements of the given types
U128 unsigned 128-bit integer primitive
U256 unsigned 256-bit integer primitive
U32 unsigned 32-bit integer primitive
U512 unsigned 512-bit integer primitive
U64 unsigned 64-bit integer primitive
U8 unsigned 8-bit integer primitive
UNIT singleton value without additional semantics
UREF unforgeable reference

Method Summary

Modifier and Type	Method and Description
static CLType	fromString(java.lang.String jsonName)
byte	getClType()
java.lang.String	getJsonName() Obtains the JSON name of the field.
static boolean	isNumeric(CLType clType)
static CLType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CLType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOL

public static final CLType BOOL

boolean primitive

I32

public static final CLType I32

signed 32-bit integer primitive

I64

public static final CLType I64

signed 64-bit integer primitive

U8

public static final CLType U8

unsigned 8-bit integer primitive

U32

public static final CLType U32

unsigned 32-bit integer primitive

U64

public static final CLType U64

unsigned 64-bit integer primitive

U128

public static final CLType U128

unsigned 128-bit integer primitive

U256

public static final CLType U256

unsigned 256-bit integer primitive

U512

public static final CLType U512

unsigned 512-bit integer primitive

UNIT

public static final CLType UNIT

singleton value without additional semantics

STRING

public static final CLType STRING

e.g. "Hello, World!"

KEY

public static final CLType KEY

global state key

UREF

public static final CLType UREF

unforgeable reference

OPTION

public static final CLType OPTION

optional value of the given type Option(CLType)

LIST

public static final CLType LIST

List of values of the given type (e.g. Vec in rust). List(CLType)

BYTE_ARRAY

public static final CLType BYTE_ARRAY

Byte array prefixed with U32 length (FixedList)

RESULT

public static final CLType RESULT

co-product of the the given types; one variant meaning success, the other failure

MAP

public static final CLType MAP

Map(CLType, CLType), // key-value association where keys and values have the given types

TUPLE_1

public static final CLType TUPLE_1

Tuple1(CLType) single value of the given type

TUPLE_2

public static final CLType TUPLE_2

Tuple2(CLType, CLType), // pair consisting of elements of the given types

TUPLE_3

public static final CLType TUPLE_3

Tuple3(CLType, CLType, CLType), // triple consisting of elements of the given types

ANY

public static final CLType ANY

Indicates the type is not known

PUBLIC_KEY

public static final CLType PUBLIC_KEY

NO DEF IN SPEC https://docs.casperlabs.io/en/latest/implementation/serialization-standard.html

Method Detail

values

public static CLType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CLType c : CLType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CLType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static CLType fromString(java.lang.String jsonName)

isNumeric

public static boolean isNumeric(CLType clType)

getClType

public byte getClType()

getJsonName

public java.lang.String getJsonName()

Obtains the JSON name of the field. If a CLName annotation exists on the CLType returns its value otherwise the name.

Returns:

the JSON name of the CLType