DataType (dataset 8.1.1 API)

java.lang.Object
- java.lang.Enum<DataType>
- - de.gsi.dataset.serializer.DataType

All Implemented Interfaces:

Serializable, Comparable<DataType>
```
public enum DataType
extends Enum<DataType>
```
Enum defining the data primitives that can be serialised. Arrays are always handled as multi-dimensional arrays.

Author:

rstein

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOOL`
`BOOL_ARRAY`
`BYTE`
`BYTE_ARRAY`
`CHAR`
`CHAR_ARRAY`
`COLLECTION`
`DOUBLE`
`DOUBLE_ARRAY`
`END_MARKER`
`ENUM`
`FLOAT`
`FLOAT_ARRAY`
`INT`
`INT_ARRAY`
`LIST`
`LONG`
`LONG_ARRAY`
`MAP`
`OTHER`
`QUEUE`
`SET`
`SHORT`
`SHORT_ARRAY`
`START_MARKER`
`STRING`
`STRING_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DataType`	`fromByte(byte value)` Returns the data type matching the given byte representation, if any.
`static DataType`	`fromClassType(Class<?> classType)` Returns the data type matching the given java class type, if any.
`static DataType`	`fromJavaTypeString(String str)` Returns the data type matching the given java string representation, if any.
`static DataType`	`fromString(String str)` Returns the data type matching the given string representation, if any.
`byte`	`getAsByte()` Returns the byte representation of the data type.
`String`	`getAsString()` Returns the string representation of the data type.
`List<Class<?>>`	`getClassTypes()` Returns the corresponding java class type matching the given data type
`String`	`getJavaName()` Returns the string representation of the java class type.
`long`	`getPrimitiveSize()`
`boolean`	`isArray()`
`boolean`	`isObject()`
`boolean`	`isScalar()`
`static DataType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DataType[]`	`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
  - START_MARKER
```
public static final DataType START_MARKER
```
  - BOOL
```
public static final DataType BOOL
```
  - BYTE
```
public static final DataType BYTE
```
  - SHORT
```
public static final DataType SHORT
```
  - INT
```
public static final DataType INT
```
  - LONG
```
public static final DataType LONG
```
  - FLOAT
```
public static final DataType FLOAT
```
  - DOUBLE
```
public static final DataType DOUBLE
```
  - CHAR
```
public static final DataType CHAR
```
  - STRING
```
public static final DataType STRING
```
  - BOOL_ARRAY
```
public static final DataType BOOL_ARRAY
```
  - BYTE_ARRAY
```
public static final DataType BYTE_ARRAY
```
  - SHORT_ARRAY
```
public static final DataType SHORT_ARRAY
```
  - INT_ARRAY
```
public static final DataType INT_ARRAY
```
  - LONG_ARRAY
```
public static final DataType LONG_ARRAY
```
  - FLOAT_ARRAY
```
public static final DataType FLOAT_ARRAY
```
  - DOUBLE_ARRAY
```
public static final DataType DOUBLE_ARRAY
```
  - CHAR_ARRAY
```
public static final DataType CHAR_ARRAY
```
  - STRING_ARRAY
```
public static final DataType STRING_ARRAY
```
  - COLLECTION
```
public static final DataType COLLECTION
```
  - ENUM
```
public static final DataType ENUM
```
  - LIST
```
public static final DataType LIST
```
  - MAP
```
public static final DataType MAP
```
  - QUEUE
```
public static final DataType QUEUE
```
  - SET
```
public static final DataType SET
```
  - OTHER
```
public static final DataType OTHER
```
  - END_MARKER
```
public static final DataType END_MARKER
```
- Method Detail
  - values
```
public static DataType[] 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 (DataType c : DataType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DataType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getAsByte
```
public byte getAsByte()
```
    Returns the byte representation of the data type.
    
    Returns:
    
    the byte representation
  - getAsString
```
public String getAsString()
```
    Returns the string representation of the data type.
    
    Returns:
    
    the string representation
  - getClassTypes
```
public List<Class<?>> getClassTypes()
```
    Returns the corresponding java class type matching the given data type
    
    Returns:
    
    the matching java class type
  - getJavaName
```
public String getJavaName()
```
    Returns the string representation of the java class type.
    
    Returns:
    
    the string representation of the class
  - getPrimitiveSize
```
public long getPrimitiveSize()
```
  - isArray
```
public boolean isArray()
```
  - isObject
```
public boolean isObject()
```
  - isScalar
```
public boolean isScalar()
```
  - fromByte
```
public static DataType fromByte(byte value)
```
    Returns the data type matching the given byte representation, if any.
    
    Parameters:
    
    value - the value to be searched
    
    Returns:
    
    the matching data type
  - fromClassType
```
public static DataType fromClassType(Class<?> classType)
```
    Returns the data type matching the given java class type, if any.
    
    Parameters:
    
    classType - the value to be searched
    
    Returns:
    
    the matching data type
  - fromJavaTypeString
```
public static DataType fromJavaTypeString(String str)
```
    Returns the data type matching the given java string representation, if any.
    
    Parameters:
    
    str - the string to be searched
    
    Returns:
    
    the matching data type
  - fromString
```
public static DataType fromString(String str)
```
    Returns the data type matching the given string representation, if any.
    
    Parameters:
    
    str - the string to be searched
    
    Returns:
    
    the matching data type

Enum DataType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

START_MARKER

BOOL

BYTE

SHORT

INT

LONG

FLOAT

DOUBLE

CHAR

STRING

BOOL_ARRAY

BYTE_ARRAY

SHORT_ARRAY

INT_ARRAY

LONG_ARRAY

FLOAT_ARRAY

DOUBLE_ARRAY

CHAR_ARRAY

STRING_ARRAY

COLLECTION

ENUM

LIST

MAP

QUEUE

SET

OTHER

END_MARKER

Method Detail

values

valueOf

getAsByte

getAsString

getClassTypes

getJavaName

getPrimitiveSize

isArray

isObject

isScalar

fromByte

fromClassType

fromJavaTypeString

fromString