Type (hermod-java-ser-api 0.0.6 API)

java.lang.Object
- java.lang.Enum<Type>
- - com.github.hermod.ser.Type

All Implemented Interfaces:

Serializable, Comparable<Type>
```
public enum Type
extends Enum<Type>
```
Type.
The enum Type represents the different potential types of a field of the Msg : Null, SkippedKeys (technical type), Integer(boolean, byte, short, int, long), Decimal (float, double), String (UTF8), Msg (a unsigned int/Value Map), Array with fixed size Values, Array with variable size Values.

Author:

anavarro - Apr 4, 2013

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY_FIXED_VALUE` ARRAY_FIXED_VALUE.
`ARRAY_VARIABLE_VALUE` ARRAY_VARIABLE_VALUE.
`BYTE` BYTE.
`DECIMAL` DECIMAL.
`DOUBLE` DOUBLE.
`FIVE_BITS_DECIMAL` FIVE_BITS_DECIMAL.
`FLOAT` FLOAT.
`INT` INT.
`INTEGER` INTEGER.
`LONG` LONG.
`MSG` MSG.
`NULL` NULL.
`SHORT` SHORT.
`SKIPPED_KEYS` SKIPPED_KEYS.
`STRING_UTF8` STRING_UTF8.

Method Summary

Methods
Modifier and Type	Method and Description
`byte`	`getId()` getId.
`byte`	`getShiftId()` get5ShiftId.
`static Type`	`valueOf(byte aId)` valueOf
`static <T> Type`	`valueOf(Class<T> clazz)` valueOf
`static Type`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Type[]`	`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
  - NULL
```
public static final Type NULL
```
    NULL.
  - SKIPPED_KEYS
```
public static final Type SKIPPED_KEYS
```
    SKIPPED_KEYS.
  - INTEGER
```
public static final Type INTEGER
```
    INTEGER.
  - BYTE
```
public static final Type BYTE
```
    BYTE.
  - SHORT
```
public static final Type SHORT
```
    SHORT.
  - INT
```
public static final Type INT
```
    INT.
  - LONG
```
public static final Type LONG
```
    LONG.
  - DECIMAL
```
public static final Type DECIMAL
```
    DECIMAL.
  - FLOAT
```
public static final Type FLOAT
```
    FLOAT.
  - DOUBLE
```
public static final Type DOUBLE
```
    DOUBLE.
  - FIVE_BITS_DECIMAL
```
public static final Type FIVE_BITS_DECIMAL
```
    FIVE_BITS_DECIMAL.
  - STRING_UTF8
```
public static final Type STRING_UTF8
```
    STRING_UTF8.
  - MSG
```
public static final Type MSG
```
    MSG.
  - ARRAY_FIXED_VALUE
```
public static final Type ARRAY_FIXED_VALUE
```
    ARRAY_FIXED_VALUE.
  - ARRAY_VARIABLE_VALUE
```
public static final Type ARRAY_VARIABLE_VALUE
```
    ARRAY_VARIABLE_VALUE.
- Method Detail
  - values
```
public static Type[] 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 (Type c : Type.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Type 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
  - getId
```
public final byte getId()
```
    getId.
    
    Returns:
    the byte representing the id of the type.
  - getShiftId
```
public final byte getShiftId()
```
    get5ShiftId.
    
    Returns:
    the byte representing the type shifted by 5 (only type, no length)
  - valueOf
```
public static Type valueOf(byte aId)
```
    valueOf
    (creation/retrieve of a Type).
    
    Parameters:
    aId - a byte representing the id of the Type which wants to retrieve.
    
    Returns:
    the Type
  - valueOf
```
public static <T> Type valueOf(Class<T> clazz)
```
    valueOf
    (creation/retrieve of a Type).
    
    Type Parameters:
    T - type of class
    Parameters:
    clazz - representing the Type which wants to retrieve the Type.
    
    Returns:
    the Type

Enum Type

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL

SKIPPED_KEYS

INTEGER

BYTE

SHORT

INT

LONG

DECIMAL

FLOAT

DOUBLE

FIVE_BITS_DECIMAL

STRING_UTF8

MSG

ARRAY_FIXED_VALUE

ARRAY_VARIABLE_VALUE

Method Detail

values

valueOf

getId

getShiftId

valueOf

valueOf