Package edu.wpi.first.util.struct

Enum Class StructFieldType

java.lang.Object

java.lang.Enum<StructFieldType>

edu.wpi.first.util.struct.StructFieldType

All Implemented Interfaces:

Serializable, Comparable<StructFieldType>, Constable

public enum StructFieldType
extends Enum<StructFieldType>

Known data types for raw struct dynamic fields (see StructFieldDescriptor).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kBool	bool.
kChar	char.
kDouble	double.
kFloat	float.
kInt16	int16.
kInt32	int32.
kInt64	int64.
kInt8	int8.
kStruct	struct.
kUint16	uint16.
kUint32	uint32.
kUint64	uint64.
kUint8	uint8.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	isInt	Indicates if the data type is a signed integer.
final boolean	isUint	Indicates if the data type is an unsigned integer.
final String	name	The name of the data type.
final int	size	The size (in bytes) of the data type.

Method Summary

Modifier and Type	Method	Description
static StructFieldType	fromString(String str)	Get field type from string.
String	toString()
static StructFieldType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StructFieldType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kBool

public static final StructFieldType kBool

bool.

kChar

public static final StructFieldType kChar

char.

kInt8

public static final StructFieldType kInt8

int8.

kInt16

public static final StructFieldType kInt16

int16.

kInt32

public static final StructFieldType kInt32

int32.

kInt64

public static final StructFieldType kInt64

int64.

kUint8

public static final StructFieldType kUint8

uint8.

kUint16

public static final StructFieldType kUint16

uint16.

kUint32

public static final StructFieldType kUint32

uint32.

kUint64

public static final StructFieldType kUint64

uint64.

kFloat

public static final StructFieldType kFloat

float.

kDouble

public static final StructFieldType kDouble

double.

kStruct

public static final StructFieldType kStruct

struct.

Field Details

name

public final String name

The name of the data type.

isInt

public final boolean isInt

Indicates if the data type is a signed integer.

isUint

public final boolean isUint

Indicates if the data type is an unsigned integer.

size

public final int size

The size (in bytes) of the data type.

Method Details

values

public static StructFieldType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StructFieldType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<StructFieldType>

fromString

public static StructFieldType fromString(String str)

Get field type from string.

Parameters:

str - string

Returns:

field type