TokenCodec (Simple Binary Encoding)

java.lang.Object
- uk.co.real_logic.sbe.ir.generated.TokenCodec

```
public class TokenCodec
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static int BLOCK_LENGTH

static int SCHEMA_ID

static int SCHEMA_VERSION

static int TEMPLATE_ID

Fields
Modifier and Type	Field and Description
`static int`	`BLOCK_LENGTH`
`static int`	`SCHEMA_ID`
`static int`	`SCHEMA_VERSION`
`static int`	`TEMPLATE_ID`

Constructor Summary

Constructors
Constructor and Description

TokenCodec()

Constructors
Constructor and Description
`TokenCodec()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteOrderCodec`	`byteOrder()`
`TokenCodec`	`byteOrder(ByteOrderCodec value)`
`static int`	`byteOrderId()`
`static String`	`byteOrderMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`characterEncodingCharacterEncoding()`
`static int`	`characterEncodingHeaderSize()`
`static int`	`characterEncodingId()`
`static String`	`characterEncodingMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`constValueCharacterEncoding()`
`static int`	`constValueHeaderSize()`
`static int`	`constValueId()`
`static String`	`constValueMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`epochCharacterEncoding()`
`static int`	`epochHeaderSize()`
`static int`	`epochId()`
`static String`	`epochMetaAttribute(MetaAttribute metaAttribute)`
`int`	`fieldId()`
`TokenCodec`	`fieldId(int value)`
`static int`	`fieldIdId()`
`static int`	`fieldIdMaxValue()`
`static String`	`fieldIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`fieldIdMinValue()`
`static int`	`fieldIdNullValue()`
`int`	`getCharacterEncoding(byte[] dst, int dstOffset, int length)`
`int`	`getConstValue(byte[] dst, int dstOffset, int length)`
`int`	`getEpoch(byte[] dst, int dstOffset, int length)`
`int`	`getMaxValue(byte[] dst, int dstOffset, int length)`
`int`	`getMinValue(byte[] dst, int dstOffset, int length)`
`int`	`getName(byte[] dst, int dstOffset, int length)`
`int`	`getNullValue(byte[] dst, int dstOffset, int length)`
`int`	`getSemanticType(byte[] dst, int dstOffset, int length)`
`int`	`getTimeUnit(byte[] dst, int dstOffset, int length)`
`int`	`limit()`
`void`	`limit(int limit)`
`static String`	`maxValueCharacterEncoding()`
`static int`	`maxValueHeaderSize()`
`static int`	`maxValueId()`
`static String`	`maxValueMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`minValueCharacterEncoding()`
`static int`	`minValueHeaderSize()`
`static int`	`minValueId()`
`static String`	`minValueMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`nameCharacterEncoding()`
`static int`	`nameHeaderSize()`
`static int`	`nameId()`
`static String`	`nameMetaAttribute(MetaAttribute metaAttribute)`
`static String`	`nullValueCharacterEncoding()`
`static int`	`nullValueHeaderSize()`
`static int`	`nullValueId()`
`static String`	`nullValueMetaAttribute(MetaAttribute metaAttribute)`
`int`	`offset()`
`PresenceCodec`	`presence()`
`TokenCodec`	`presence(PresenceCodec value)`
`static int`	`presenceId()`
`static String`	`presenceMetaAttribute(MetaAttribute metaAttribute)`
`PrimitiveTypeCodec`	`primitiveType()`
`TokenCodec`	`primitiveType(PrimitiveTypeCodec value)`
`static int`	`primitiveTypeId()`
`static String`	`primitiveTypeMetaAttribute(MetaAttribute metaAttribute)`
`int`	`putCharacterEncoding(byte[] src, int srcOffset, int length)`
`int`	`putConstValue(byte[] src, int srcOffset, int length)`
`int`	`putEpoch(byte[] src, int srcOffset, int length)`
`int`	`putMaxValue(byte[] src, int srcOffset, int length)`
`int`	`putMinValue(byte[] src, int srcOffset, int length)`
`int`	`putName(byte[] src, int srcOffset, int length)`
`int`	`putNullValue(byte[] src, int srcOffset, int length)`
`int`	`putSemanticType(byte[] src, int srcOffset, int length)`
`int`	`putTimeUnit(byte[] src, int srcOffset, int length)`
`int`	`sbeBlockLength()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`int`	`sbeTemplateId()`
`static String`	`semanticTypeCharacterEncoding()`
`static int`	`semanticTypeHeaderSize()`
`static int`	`semanticTypeId()`
`static String`	`semanticTypeMetaAttribute(MetaAttribute metaAttribute)`
`SignalCodec`	`signal()`
`TokenCodec`	`signal(SignalCodec value)`
`static int`	`signalId()`
`static String`	`signalMetaAttribute(MetaAttribute metaAttribute)`
`int`	`size()`
`static String`	`timeUnitCharacterEncoding()`
`static int`	`timeUnitHeaderSize()`
`static int`	`timeUnitId()`
`static String`	`timeUnitMetaAttribute(MetaAttribute metaAttribute)`
`int`	`tokenOffset()`
`TokenCodec`	`tokenOffset(int value)`
`static int`	`tokenOffsetId()`
`static int`	`tokenOffsetMaxValue()`
`static String`	`tokenOffsetMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`tokenOffsetMinValue()`
`static int`	`tokenOffsetNullValue()`
`int`	`tokenSize()`
`TokenCodec`	`tokenSize(int value)`
`static int`	`tokenSizeId()`
`static int`	`tokenSizeMaxValue()`
`static String`	`tokenSizeMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`tokenSizeMinValue()`
`static int`	`tokenSizeNullValue()`
`int`	`tokenVersion()`
`TokenCodec`	`tokenVersion(int value)`
`static int`	`tokenVersionId()`
`static int`	`tokenVersionMaxValue()`
`static String`	`tokenVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`tokenVersionMinValue()`
`static int`	`tokenVersionNullValue()`
`TokenCodec`	`wrapForDecode(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`TokenCodec`	`wrapForEncode(DirectBuffer buffer, int offset)`

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

Field Detail
- BLOCK_LENGTH
```
public static final int BLOCK_LENGTH
```
  See Also:
  
  Constant Field Values
- TEMPLATE_ID
```
public static final int TEMPLATE_ID
```
  See Also:
  
  Constant Field Values
- SCHEMA_ID
```
public static final int SCHEMA_ID
```
  See Also:
  
  Constant Field Values
- SCHEMA_VERSION
```
public static final int SCHEMA_VERSION
```
  See Also:
  
  Constant Field Values

Constructor Detail
- TokenCodec
```
public TokenCodec()
```

Method Detail

sbeBlockLength
```
public int sbeBlockLength()
```

sbeTemplateId
```
public int sbeTemplateId()
```

sbeSchemaId
```
public int sbeSchemaId()
```

sbeSchemaVersion
```
public int sbeSchemaVersion()
```

sbeSemanticType
```
public String sbeSemanticType()
```

offset
```
public int offset()
```

wrapForEncode

public TokenCodec wrapForEncode(DirectBuffer buffer,
                                int offset)

wrapForDecode

public TokenCodec wrapForDecode(DirectBuffer buffer,
                                int offset,
                                int actingBlockLength,
                                int actingVersion)

size
```
public int size()
```

limit
```
public int limit()
```

limit
```
public void limit(int limit)
```

tokenOffsetId
```
public static int tokenOffsetId()
```

tokenOffsetMetaAttribute

public static String tokenOffsetMetaAttribute(MetaAttribute metaAttribute)

tokenOffsetNullValue

public static int tokenOffsetNullValue()

tokenOffsetMinValue

public static int tokenOffsetMinValue()

tokenOffsetMaxValue

public static int tokenOffsetMaxValue()

tokenOffset
```
public int tokenOffset()
```

tokenOffset

public TokenCodec tokenOffset(int value)

tokenSizeId
```
public static int tokenSizeId()
```

tokenSizeMetaAttribute

public static String tokenSizeMetaAttribute(MetaAttribute metaAttribute)

tokenSizeNullValue

public static int tokenSizeNullValue()

tokenSizeMinValue
```
public static int tokenSizeMinValue()
```

tokenSizeMaxValue
```
public static int tokenSizeMaxValue()
```

tokenSize
```
public int tokenSize()
```

tokenSize

public TokenCodec tokenSize(int value)

fieldIdId
```
public static int fieldIdId()
```

fieldIdMetaAttribute

public static String fieldIdMetaAttribute(MetaAttribute metaAttribute)

fieldIdNullValue
```
public static int fieldIdNullValue()
```

fieldIdMinValue
```
public static int fieldIdMinValue()
```

fieldIdMaxValue
```
public static int fieldIdMaxValue()
```

fieldId
```
public int fieldId()
```

fieldId
```
public TokenCodec fieldId(int value)
```

tokenVersionId
```
public static int tokenVersionId()
```

tokenVersionMetaAttribute

public static String tokenVersionMetaAttribute(MetaAttribute metaAttribute)

tokenVersionNullValue

public static int tokenVersionNullValue()

tokenVersionMinValue

public static int tokenVersionMinValue()

tokenVersionMaxValue

public static int tokenVersionMaxValue()

tokenVersion
```
public int tokenVersion()
```

tokenVersion

public TokenCodec tokenVersion(int value)

signalId
```
public static int signalId()
```

signalMetaAttribute

public static String signalMetaAttribute(MetaAttribute metaAttribute)

signal
```
public SignalCodec signal()
```

signal

public TokenCodec signal(SignalCodec value)

primitiveTypeId
```
public static int primitiveTypeId()
```

primitiveTypeMetaAttribute

public static String primitiveTypeMetaAttribute(MetaAttribute metaAttribute)

primitiveType

public PrimitiveTypeCodec primitiveType()

primitiveType

public TokenCodec primitiveType(PrimitiveTypeCodec value)

byteOrderId
```
public static int byteOrderId()
```

byteOrderMetaAttribute

public static String byteOrderMetaAttribute(MetaAttribute metaAttribute)

byteOrder
```
public ByteOrderCodec byteOrder()
```

byteOrder

public TokenCodec byteOrder(ByteOrderCodec value)

presenceId
```
public static int presenceId()
```

presenceMetaAttribute

public static String presenceMetaAttribute(MetaAttribute metaAttribute)

presence
```
public PresenceCodec presence()
```

presence

public TokenCodec presence(PresenceCodec value)

nameId
```
public static int nameId()
```

nameCharacterEncoding

public static String nameCharacterEncoding()

nameMetaAttribute

public static String nameMetaAttribute(MetaAttribute metaAttribute)

nameHeaderSize
```
public static int nameHeaderSize()
```

getName

public int getName(byte[] dst,
                   int dstOffset,
                   int length)

putName

public int putName(byte[] src,
                   int srcOffset,
                   int length)

constValueId
```
public static int constValueId()
```

constValueCharacterEncoding

public static String constValueCharacterEncoding()

constValueMetaAttribute

public static String constValueMetaAttribute(MetaAttribute metaAttribute)

constValueHeaderSize

public static int constValueHeaderSize()

getConstValue

public int getConstValue(byte[] dst,
                         int dstOffset,
                         int length)

putConstValue

public int putConstValue(byte[] src,
                         int srcOffset,
                         int length)

minValueId
```
public static int minValueId()
```

minValueCharacterEncoding

public static String minValueCharacterEncoding()

minValueMetaAttribute

public static String minValueMetaAttribute(MetaAttribute metaAttribute)

minValueHeaderSize

public static int minValueHeaderSize()

getMinValue

public int getMinValue(byte[] dst,
                       int dstOffset,
                       int length)

putMinValue

public int putMinValue(byte[] src,
                       int srcOffset,
                       int length)

maxValueId
```
public static int maxValueId()
```

maxValueCharacterEncoding

public static String maxValueCharacterEncoding()

maxValueMetaAttribute

public static String maxValueMetaAttribute(MetaAttribute metaAttribute)

maxValueHeaderSize

public static int maxValueHeaderSize()

getMaxValue

public int getMaxValue(byte[] dst,
                       int dstOffset,
                       int length)

putMaxValue

public int putMaxValue(byte[] src,
                       int srcOffset,
                       int length)

nullValueId
```
public static int nullValueId()
```

nullValueCharacterEncoding

public static String nullValueCharacterEncoding()

nullValueMetaAttribute

public static String nullValueMetaAttribute(MetaAttribute metaAttribute)

nullValueHeaderSize

public static int nullValueHeaderSize()

getNullValue

public int getNullValue(byte[] dst,
                        int dstOffset,
                        int length)

putNullValue

public int putNullValue(byte[] src,
                        int srcOffset,
                        int length)

characterEncodingId

public static int characterEncodingId()

characterEncodingCharacterEncoding

public static String characterEncodingCharacterEncoding()

characterEncodingMetaAttribute

public static String characterEncodingMetaAttribute(MetaAttribute metaAttribute)

characterEncodingHeaderSize

public static int characterEncodingHeaderSize()

getCharacterEncoding

public int getCharacterEncoding(byte[] dst,
                                int dstOffset,
                                int length)

putCharacterEncoding

public int putCharacterEncoding(byte[] src,
                                int srcOffset,
                                int length)

epochId
```
public static int epochId()
```

epochCharacterEncoding

public static String epochCharacterEncoding()

epochMetaAttribute

public static String epochMetaAttribute(MetaAttribute metaAttribute)

epochHeaderSize
```
public static int epochHeaderSize()
```

getEpoch

public int getEpoch(byte[] dst,
                    int dstOffset,
                    int length)

putEpoch

public int putEpoch(byte[] src,
                    int srcOffset,
                    int length)

timeUnitId
```
public static int timeUnitId()
```

timeUnitCharacterEncoding

public static String timeUnitCharacterEncoding()

timeUnitMetaAttribute

public static String timeUnitMetaAttribute(MetaAttribute metaAttribute)

timeUnitHeaderSize

public static int timeUnitHeaderSize()

getTimeUnit

public int getTimeUnit(byte[] dst,
                       int dstOffset,
                       int length)

putTimeUnit

public int putTimeUnit(byte[] src,
                       int srcOffset,
                       int length)

semanticTypeId
```
public static int semanticTypeId()
```

semanticTypeCharacterEncoding

public static String semanticTypeCharacterEncoding()

semanticTypeMetaAttribute

public static String semanticTypeMetaAttribute(MetaAttribute metaAttribute)

semanticTypeHeaderSize

public static int semanticTypeHeaderSize()

getSemanticType

public int getSemanticType(byte[] dst,
                           int dstOffset,
                           int length)

putSemanticType

public int putSemanticType(byte[] src,
                           int srcOffset,
                           int length)

Class TokenCodec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

Constructor Detail

TokenCodec

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

offset

wrapForEncode

wrapForDecode

size

limit

limit

tokenOffsetId

tokenOffsetMetaAttribute

tokenOffsetNullValue

tokenOffsetMinValue

tokenOffsetMaxValue

tokenOffset

tokenOffset

tokenSizeId

tokenSizeMetaAttribute

tokenSizeNullValue

tokenSizeMinValue

tokenSizeMaxValue

tokenSize

tokenSize

fieldIdId

fieldIdMetaAttribute

fieldIdNullValue

fieldIdMinValue

fieldIdMaxValue

fieldId

fieldId

tokenVersionId

tokenVersionMetaAttribute

tokenVersionNullValue

tokenVersionMinValue

tokenVersionMaxValue

tokenVersion

tokenVersion

signalId

signalMetaAttribute

signal

signal

primitiveTypeId

primitiveTypeMetaAttribute

primitiveType

primitiveType

byteOrderId

byteOrderMetaAttribute

byteOrder

byteOrder

presenceId

presenceMetaAttribute

presence

presence

nameId

nameCharacterEncoding

nameMetaAttribute

nameHeaderSize

getName

putName

constValueId

constValueCharacterEncoding

constValueMetaAttribute

constValueHeaderSize

getConstValue

putConstValue