com.github.ykiselev.binary.format

Class Types

java.lang.Object

com.github.ykiselev.binary.format.Types

public final class Types
extends Object

Each serialized property is stored as a pair of header and data. Where header has size of one byte and data can vary from zero to N bytes. Header consist of two parts - lower four bits encode property type (see below) and higher four bits encode element type for arrays.

Created by Y.Kiselev on 26.06.2016.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ARRAY TYPE(bits 0-3), ELEMENT_TYPE(bits 4-7), LENGTH_IN_ELEMENTS(1-4b), VALUE(n)
static byte	BOOLEAN TYPE(bits 0-3) VALUE(bit 4) RESERVED(bits 5-7)
static byte	BYTE TYPE(1b), VALUE(1b)
static byte	CHAR TYPE(1b), VALUE(2b)
static byte	DOUBLE TYPE(1b), VALUE(8b)
static byte	END_MARKER TYPE(1b)
static byte	FLOAT TYPE(1b), VALUE(4b)
static byte	INT TYPE(1b), VALUE(4b)
static byte	LONG TYPE(1b), VALUE(8b)
static byte	MASK Type mask, first four bits
static byte	NULL TYPE(1b)
static byte	SHORT TYPE(1b), VALUE(2b)
static byte	STRING UTF-8 string TYPE(1b), LENGTH(1-4b), VALUE(n)
static byte	USER_TYPE TYPE(1b), 0..N * ( TYPE(1b), VALUE( f(type) ) ), END_MARKER

Constructor Summary

Constructors

Constructor and Description
Types()

Method Summary

Methods

Modifier and Type	Method and Description
static byte	array(int itemType) Combines array type with item type in single byte
static boolean	isArray(int value) Checks if supplied type is an array
static int	subType(int value) Extracts sub type (higher four bits) from type byte

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MASK

public static final byte MASK

Type mask, first four bits

See Also:

Constant Field Values

BYTE

public static final byte BYTE

TYPE(1b), VALUE(1b)

See Also:

Constant Field Values

CHAR

public static final byte CHAR

TYPE(1b), VALUE(2b)

See Also:

Constant Field Values

SHORT

public static final byte SHORT

TYPE(1b), VALUE(2b)

See Also:

Constant Field Values

INT

public static final byte INT

TYPE(1b), VALUE(4b)

See Also:

Constant Field Values

LONG

public static final byte LONG

TYPE(1b), VALUE(8b)

See Also:

Constant Field Values

FLOAT

public static final byte FLOAT

TYPE(1b), VALUE(4b)

See Also:

Constant Field Values

DOUBLE

public static final byte DOUBLE

TYPE(1b), VALUE(8b)

See Also:

Constant Field Values

STRING

public static final byte STRING

UTF-8 string TYPE(1b), LENGTH(1-4b), VALUE(n)

See Also:

Constant Field Values

ARRAY

public static final byte ARRAY

TYPE(bits 0-3), ELEMENT_TYPE(bits 4-7), LENGTH_IN_ELEMENTS(1-4b), VALUE(n)

See Also:

Constant Field Values

NULL

public static final byte NULL

TYPE(1b)

See Also:

Constant Field Values

USER_TYPE

public static final byte USER_TYPE

TYPE(1b), 0..N * ( TYPE(1b), VALUE( f(type) ) ), END_MARKER

See Also:

Constant Field Values

END_MARKER

public static final byte END_MARKER

TYPE(1b)

See Also:

Constant Field Values

BOOLEAN

public static final byte BOOLEAN

TYPE(bits 0-3) VALUE(bit 4) RESERVED(bits 5-7)

See Also:

Constant Field Values

Constructor Detail

Types

public Types()

Method Detail

isArray

public static boolean isArray(int value)

Checks if supplied type is an array

Parameters:

value - the type byte

Returns:

true if this is array, false otherwise

subType

public static int subType(int value)

Extracts sub type (higher four bits) from type byte

Parameters:

value - the type byte

Returns:

the sub type

array

public static byte array(int itemType)

Combines array type with item type in single byte

Parameters:

itemType - the type of array item