PrimitiveValue (Simple Binary Encoding)

java.lang.Object
- uk.co.real_logic.sbe.PrimitiveValue

```
public class PrimitiveValue
extends java.lang.Object
```
Class used to encapsulate values for primitives. Used for nullValue, minValue, maxValue, and constants

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PrimitiveValue.Representation

Nested Classes
Modifier and Type	Class and Description
`static class`	`PrimitiveValue.Representation`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.math.BigInteger`	`BI_MAX_VALUE_UINT64`
`static java.math.BigInteger`	`BI_NULL_VALUE_UINT64`
`static long`	`MAX_VALUE_CHAR`
`static double`	`MAX_VALUE_DOUBLE`
`static float`	`MAX_VALUE_FLOAT`
`static long`	`MAX_VALUE_INT16`
`static long`	`MAX_VALUE_INT32`
`static long`	`MAX_VALUE_INT64`
`static long`	`MAX_VALUE_INT8`
`static long`	`MAX_VALUE_UINT16`
`static long`	`MAX_VALUE_UINT32`
`static long`	`MAX_VALUE_UINT64`
`static long`	`MAX_VALUE_UINT8`
`static long`	`MIN_VALUE_CHAR`
`static double`	`MIN_VALUE_DOUBLE`
`static float`	`MIN_VALUE_FLOAT`
`static long`	`MIN_VALUE_INT16`
`static long`	`MIN_VALUE_INT32`
`static long`	`MIN_VALUE_INT64`
`static long`	`MIN_VALUE_INT8`
`static long`	`MIN_VALUE_UINT16`
`static long`	`MIN_VALUE_UINT32`
`static long`	`MIN_VALUE_UINT64`
`static long`	`MIN_VALUE_UINT8`
`static long`	`NULL_VALUE_CHAR`
`static double`	`NULL_VALUE_DOUBLE`
`static float`	`NULL_VALUE_FLOAT`
`static long`	`NULL_VALUE_INT16`
`static long`	`NULL_VALUE_INT32`
`static long`	`NULL_VALUE_INT64`
`static long`	`NULL_VALUE_INT8`
`static long`	`NULL_VALUE_UINT16`
`static long`	`NULL_VALUE_UINT32`
`static long`	`NULL_VALUE_UINT64`
`static long`	`NULL_VALUE_UINT8`

Constructor Summary

Constructors
Constructor and Description
`PrimitiveValue(byte[] value, java.lang.String characterEncoding, int size)` Construct and fill in value as a byte array.
`PrimitiveValue(byte value, java.lang.String characterEncoding)` Construct and fill in value as a long.
`PrimitiveValue(double value, int size)` Construct and fill in value as a double.
`PrimitiveValue(long value, int size)` Construct and fill in value as a long.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`byteArrayValue()` Return byte array value for this PrimitiveValue.
`byte[]`	`byteArrayValue(PrimitiveType type)` Return byte array value for this PrimitiveValue given a particular type
`java.lang.String`	`characterEncoding()` The character encoding of the byte array representation.
`double`	`doubleValue()` Return double value for this PrimitiveValue.
`boolean`	`equals(java.lang.Object value)` Determine if two values are equivalent.
`int`	`hashCode()` Return hashCode for value.
`long`	`longValue()` Return long value for this PrimitiveValue
`static PrimitiveValue`	`parse(java.lang.String value, int length, java.lang.String characterEncoding)` Parse constant value string and set representation based on type, length, and characterEncoding
`static PrimitiveValue`	`parse(java.lang.String value, PrimitiveType primitiveType)` Parse constant value string and set representation based on type
`static PrimitiveValue`	`parse(java.lang.String value, PrimitiveType primitiveType, java.lang.String characterEncoding)` Parse constant value string and set representation based on type
`PrimitiveValue.Representation`	`representation()` Get the `PrimitiveValue.Representation` of the value.
`int`	`size()` Return encodedLength for this PrimitiveValue for serialization purposes.
`java.lang.String`	`toString()` Return String representation of this object

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_VALUE_CHAR
```
public static final long MIN_VALUE_CHAR
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_CHAR
```
public static final long MAX_VALUE_CHAR
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_CHAR
```
public static final long NULL_VALUE_CHAR
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_INT8
```
public static final long MIN_VALUE_INT8
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_INT8
```
public static final long MAX_VALUE_INT8
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_INT8
```
public static final long NULL_VALUE_INT8
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_UINT8
```
public static final long MIN_VALUE_UINT8
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_UINT8
```
public static final long MAX_VALUE_UINT8
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_UINT8
```
public static final long NULL_VALUE_UINT8
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_INT16
```
public static final long MIN_VALUE_INT16
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_INT16
```
public static final long MAX_VALUE_INT16
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_INT16
```
public static final long NULL_VALUE_INT16
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_UINT16
```
public static final long MIN_VALUE_UINT16
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_UINT16
```
public static final long MAX_VALUE_UINT16
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_UINT16
```
public static final long NULL_VALUE_UINT16
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_INT32
```
public static final long MIN_VALUE_INT32
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_INT32
```
public static final long MAX_VALUE_INT32
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_INT32
```
public static final long NULL_VALUE_INT32
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_UINT32
```
public static final long MIN_VALUE_UINT32
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_UINT32
```
public static final long MAX_VALUE_UINT32
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_UINT32
```
public static final long NULL_VALUE_UINT32
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_INT64
```
public static final long MIN_VALUE_INT64
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_INT64
```
public static final long MAX_VALUE_INT64
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_INT64
```
public static final long NULL_VALUE_INT64
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_UINT64
```
public static final long MIN_VALUE_UINT64
```
    See Also:
    
    Constant Field Values
  - BI_MAX_VALUE_UINT64
```
public static final java.math.BigInteger BI_MAX_VALUE_UINT64
```
  - MAX_VALUE_UINT64
```
public static final long MAX_VALUE_UINT64
```
  - BI_NULL_VALUE_UINT64
```
public static final java.math.BigInteger BI_NULL_VALUE_UINT64
```
  - NULL_VALUE_UINT64
```
public static final long NULL_VALUE_UINT64
```
  - MIN_VALUE_FLOAT
```
public static final float MIN_VALUE_FLOAT
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_FLOAT
```
public static final float MAX_VALUE_FLOAT
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_FLOAT
```
public static final float NULL_VALUE_FLOAT
```
    See Also:
    
    Constant Field Values
  - MIN_VALUE_DOUBLE
```
public static final double MIN_VALUE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_DOUBLE
```
public static final double MAX_VALUE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_DOUBLE
```
public static final double NULL_VALUE_DOUBLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PrimitiveValue
```
public PrimitiveValue(long value,
                      int size)
```
    Construct and fill in value as a long.
    
    Parameters:
    
    value - in long format
    
    size - of the type in bytes
  - PrimitiveValue
```
public PrimitiveValue(byte value,
                      java.lang.String characterEncoding)
```
    Construct and fill in value as a long.
    
    Parameters:
    
    value - in long format
    
    characterEncoding - of the char type.
  - PrimitiveValue
```
public PrimitiveValue(double value,
                      int size)
```
    Construct and fill in value as a double.
    
    Parameters:
    
    value - in double format
    
    size - of the type in bytes
  - PrimitiveValue
```
public PrimitiveValue(byte[] value,
                      java.lang.String characterEncoding,
                      int size)
```
    Construct and fill in value as a byte array.
    
    Parameters:
    
    value - as a byte array
    
    characterEncoding - of the characters
    
    size - of string in characters
- Method Detail
  - representation
```
public PrimitiveValue.Representation representation()
```
    Get the PrimitiveValue.Representation of the value.
    
    Returns:
    
    the PrimitiveValue.Representation of the value.
  - parse
```
public static PrimitiveValue parse(java.lang.String value,
                                   PrimitiveType primitiveType)
```
    Parse constant value string and set representation based on type
    
    Parameters:
    
    value - expressed as a String
    
    primitiveType - that this is supposed to be
    
    Returns:
    
    a new PrimitiveValue for the value.
    
    Throws:
    
    java.lang.IllegalArgumentException - if parsing malformed type
  - parse
```
public static PrimitiveValue parse(java.lang.String value,
                                   PrimitiveType primitiveType,
                                   java.lang.String characterEncoding)
```
    Parse constant value string and set representation based on type
    
    Parameters:
    
    value - expressed as a String
    
    primitiveType - that this is supposed to be
    
    characterEncoding - of the constant value.
    
    Returns:
    
    a new PrimitiveValue for the value.
    
    Throws:
    
    java.lang.IllegalArgumentException - if parsing malformed type
  - parse
```
public static PrimitiveValue parse(java.lang.String value,
                                   int length,
                                   java.lang.String characterEncoding)
```
    Parse constant value string and set representation based on type, length, and characterEncoding
    
    Parameters:
    
    value - expressed as a String
    
    length - of the type
    
    characterEncoding - of the String
    
    Returns:
    
    a new PrimitiveValue for the value.
    
    Throws:
    
    java.lang.IllegalArgumentException - if parsing malformed type
  - longValue
```
public long longValue()
```
    Return long value for this PrimitiveValue
    
    Returns:
    
    value expressed as a long
    
    Throws:
    
    java.lang.IllegalStateException - if not a long value representation
  - doubleValue
```
public double doubleValue()
```
    Return double value for this PrimitiveValue.
    
    Returns:
    
    value expressed as a double
    
    Throws:
    
    java.lang.IllegalStateException - if not a double value representation
  - byteArrayValue
```
public byte[] byteArrayValue()
```
    Return byte array value for this PrimitiveValue.
    
    Returns:
    
    value expressed as a byte array
    
    Throws:
    
    java.lang.IllegalStateException - if not a byte array value representation
  - byteArrayValue
```
public byte[] byteArrayValue(PrimitiveType type)
```
    Return byte array value for this PrimitiveValue given a particular type
    
    Parameters:
    
    type - of this value
    
    Returns:
    
    value expressed as a byte array
    
    Throws:
    
    java.lang.IllegalStateException - if not a byte array value representation
  - size
```
public int size()
```
    Return encodedLength for this PrimitiveValue for serialization purposes.
    
    Returns:
    
    encodedLength for serialization
  - characterEncoding
```
public java.lang.String characterEncoding()
```
    The character encoding of the byte array representation.
    
    Returns:
    
    the character encoding of te byte array representation.
  - toString
```
public java.lang.String toString()
```
    Return String representation of this object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representing object value
  - equals
```
public boolean equals(java.lang.Object value)
```
    Determine if two values are equivalent.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    value - to compare this value with
    
    Returns:
    
    equivalence of values
  - hashCode
```
public int hashCode()
```
    Return hashCode for value. This is the underlying representations hashCode for the value
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    int value of the hashCode

Class PrimitiveValue

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_VALUE_CHAR

MAX_VALUE_CHAR

NULL_VALUE_CHAR

MIN_VALUE_INT8

MAX_VALUE_INT8

NULL_VALUE_INT8

MIN_VALUE_UINT8

MAX_VALUE_UINT8

NULL_VALUE_UINT8

MIN_VALUE_INT16

MAX_VALUE_INT16

NULL_VALUE_INT16

MIN_VALUE_UINT16

MAX_VALUE_UINT16

NULL_VALUE_UINT16

MIN_VALUE_INT32

MAX_VALUE_INT32

NULL_VALUE_INT32

MIN_VALUE_UINT32

MAX_VALUE_UINT32

NULL_VALUE_UINT32

MIN_VALUE_INT64

MAX_VALUE_INT64

NULL_VALUE_INT64

MIN_VALUE_UINT64

BI_MAX_VALUE_UINT64

MAX_VALUE_UINT64

BI_NULL_VALUE_UINT64

NULL_VALUE_UINT64

MIN_VALUE_FLOAT

MAX_VALUE_FLOAT

NULL_VALUE_FLOAT

MIN_VALUE_DOUBLE

MAX_VALUE_DOUBLE

NULL_VALUE_DOUBLE

Constructor Detail

PrimitiveValue

PrimitiveValue

PrimitiveValue

PrimitiveValue

Method Detail

representation

parse

parse

parse

longValue

doubleValue

byteArrayValue

byteArrayValue

size

characterEncoding

toString

equals

hashCode