Encoding (Simple Binary Encoding (SBE))

java.lang.Object
- uk.co.real_logic.sbe.ir.Encoding

```
public class Encoding
extends Object
```
Optional encoding settings that can be associated with Tokens.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Encoding.Builder` Builder to make `Encoding` easier to create.
`static class`	`Encoding.Presence` Indicates the presence status of a primitive encoded field in a message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PrimitiveValue`	`applicableMaxValue()` The most applicable max value for the encoded type.
`PrimitiveValue`	`applicableMinValue()` The most applicable min value for the encoded type.
`PrimitiveValue`	`applicableNullValue()` The most applicable null value for the encoded type.
`ByteOrder`	`byteOrder()` The `ByteOrder` for this encoding.
`String`	`characterEncoding()` The character encoding for the token or null if not set.
`PrimitiveValue`	`constValue()` The constant value for the token or null if not set.
`String`	`epoch()` The epoch from which a timestamp is offset.
`PrimitiveValue`	`maxValue()` The max value for the token or null if not set.
`PrimitiveValue`	`minValue()` The min value for the token or null if not set.
`PrimitiveValue`	`nullValue()` The null value for the token or null if not set.
`Encoding.Presence`	`presence()` Indicates the presence status of a field in a message.
`void`	`presence(Encoding.Presence presence)` Set the `Encoding.Presence` for this encoding.
`PrimitiveType`	`primitiveType()` The `PrimitiveType` of this encoding.
`String`	`semanticType()` The semantic type of encoding value which can have relevance to the application layer.
`String`	`timeUnit()` The time unit of the timestamp.
`String`	`toString()`

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

- Method Detail
  - primitiveType
```
public PrimitiveType primitiveType()
```
    The PrimitiveType of this encoding.
    
    Returns:
    
    the PrimitiveType of this encoding.
  - byteOrder
```
public ByteOrder byteOrder()
```
    The ByteOrder for this encoding.
    
    Returns:
    
    the ByteOrder for this encoding.
  - minValue
```
public PrimitiveValue minValue()
```
    The min value for the token or null if not set.
    
    Returns:
    
    the minValue for the token or null if not set.
  - maxValue
```
public PrimitiveValue maxValue()
```
    The max value for the token or null if not set.
    
    Returns:
    
    the maxValue for the token or null if not set.
  - nullValue
```
public PrimitiveValue nullValue()
```
    The null value for the token or null if not set.
    
    Returns:
    
    the nullValue for the token or null if not set.
  - constValue
```
public PrimitiveValue constValue()
```
    The constant value for the token or null if not set.
    
    Returns:
    
    the constant value for the token or null if not set.
  - presence
```
public Encoding.Presence presence()
```
    Indicates the presence status of a field in a message.
    
    Returns:
    
    indicates the presence status of a field in a message.
  - presence
```
public void presence(Encoding.Presence presence)
```
    Set the Encoding.Presence for this encoding.
    
    Parameters:
    
    presence - the Encoding.Presence for this encoding.
  - applicableNullValue
```
public PrimitiveValue applicableNullValue()
```
    The most applicable null value for the encoded type.
    
    Returns:
    
    most applicable null value for the encoded type.
  - applicableMinValue
```
public PrimitiveValue applicableMinValue()
```
    The most applicable min value for the encoded type.
    
    Returns:
    
    most applicable min value for the encoded type.
  - applicableMaxValue
```
public PrimitiveValue applicableMaxValue()
```
    The most applicable max value for the encoded type.
    
    Returns:
    
    most applicable max value for the encoded type.
  - characterEncoding
```
public String characterEncoding()
```
    The character encoding for the token or null if not set.
    
    Returns:
    
    the character encoding for the token or null if not set.
  - epoch
```
public String epoch()
```
    The epoch from which a timestamp is offset. The default is "unix".
    
    Returns:
    
    the epoch from which a timestamp is offset.
  - timeUnit
```
public String timeUnit()
```
    The time unit of the timestamp.
    
    Returns:
    
    the time unit of the timestamp.
  - semanticType
```
public String semanticType()
```
    The semantic type of encoding value which can have relevance to the application layer.
    
    Returns:
    
    semantic type of encoding value which can have relevance to the application layer.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Encoding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

primitiveType

byteOrder

minValue

maxValue

nullValue

constValue

presence

presence

applicableNullValue

applicableMinValue

applicableMaxValue

characterEncoding

epoch

timeUnit

semanticType

toString