FrameCodecEncoder (Simple Binary Encoding (SBE))

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

public class FrameCodecEncoder
extends Object

Frame Header for start of encoding IR

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLOCK_LENGTH`
`static ByteOrder`	`BYTE_ORDER`
`protected int`	`initialOffset`
`protected int`	`limit`
`protected int`	`offset`
`static int`	`SCHEMA_ID`
`static int`	`SCHEMA_VERSION`
`static int`	`TEMPLATE_ID`

Constructor Summary

Constructors
Constructor and Description

FrameCodecEncoder()

Constructors
Constructor and Description
`FrameCodecEncoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuilder`	`appendTo(StringBuilder builder)`
`MutableDirectBuffer`	`buffer()`
`int`	`encodedLength()`
`int`	`initialOffset()`
`FrameCodecEncoder`	`irId(int value)`
`static int`	`irIdEncodingLength()`
`static int`	`irIdEncodingOffset()`
`static int`	`irIdId()`
`static int`	`irIdMaxValue()`
`static String`	`irIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irIdMinValue()`
`static int`	`irIdNullValue()`
`static int`	`irIdSinceVersion()`
`FrameCodecEncoder`	`irVersion(int value)`
`static int`	`irVersionEncodingLength()`
`static int`	`irVersionEncodingOffset()`
`static int`	`irVersionId()`
`static int`	`irVersionMaxValue()`
`static String`	`irVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irVersionMinValue()`
`static int`	`irVersionNullValue()`
`static int`	`irVersionSinceVersion()`
`int`	`limit()`
`void`	`limit(int limit)`
`FrameCodecEncoder`	`namespaceName(String value)`
`static String`	`namespaceNameCharacterEncoding()`
`static int`	`namespaceNameHeaderLength()`
`static int`	`namespaceNameId()`
`static String`	`namespaceNameMetaAttribute(MetaAttribute metaAttribute)`
`int`	`offset()`
`FrameCodecEncoder`	`packageName(String value)`
`static String`	`packageNameCharacterEncoding()`
`static int`	`packageNameHeaderLength()`
`static int`	`packageNameId()`
`static String`	`packageNameMetaAttribute(MetaAttribute metaAttribute)`
`FrameCodecEncoder`	`putNamespaceName(byte[] src, int srcOffset, int length)`
`FrameCodecEncoder`	`putNamespaceName(DirectBuffer src, int srcOffset, int length)`
`FrameCodecEncoder`	`putPackageName(byte[] src, int srcOffset, int length)`
`FrameCodecEncoder`	`putPackageName(DirectBuffer src, int srcOffset, int length)`
`FrameCodecEncoder`	`putSemanticVersion(byte[] src, int srcOffset, int length)`
`FrameCodecEncoder`	`putSemanticVersion(DirectBuffer src, int srcOffset, int length)`
`int`	`sbeBlockLength()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`int`	`sbeTemplateId()`
`FrameCodecEncoder`	`schemaVersion(int value)`
`static int`	`schemaVersionEncodingLength()`
`static int`	`schemaVersionEncodingOffset()`
`static int`	`schemaVersionId()`
`static int`	`schemaVersionMaxValue()`
`static String`	`schemaVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`schemaVersionMinValue()`
`static int`	`schemaVersionNullValue()`
`static int`	`schemaVersionSinceVersion()`
`FrameCodecEncoder`	`semanticVersion(String value)`
`static String`	`semanticVersionCharacterEncoding()`
`static int`	`semanticVersionHeaderLength()`
`static int`	`semanticVersionId()`
`static String`	`semanticVersionMetaAttribute(MetaAttribute metaAttribute)`
`String`	`toString()`
`FrameCodecEncoder`	`wrap(MutableDirectBuffer buffer, int offset)`
`FrameCodecEncoder`	`wrapAndApplyHeader(MutableDirectBuffer buffer, int offset, MessageHeaderEncoder headerEncoder)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

initialOffset
```
protected int initialOffset
```

offset
```
protected int offset
```

limit
```
protected int limit
```

Constructor Detail
- FrameCodecEncoder
```
public FrameCodecEncoder()
```

Method Detail

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

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

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

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

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

buffer
```
public MutableDirectBuffer buffer()
```

initialOffset
```
public int initialOffset()
```

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

wrap

public FrameCodecEncoder wrap(MutableDirectBuffer buffer,
                              int offset)

wrapAndApplyHeader

public FrameCodecEncoder wrapAndApplyHeader(MutableDirectBuffer buffer,
                                            int offset,
                                            MessageHeaderEncoder headerEncoder)

encodedLength
```
public int encodedLength()
```

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

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

irIdId
```
public static int irIdId()
```

irIdSinceVersion
```
public static int irIdSinceVersion()
```

irIdEncodingOffset

public static int irIdEncodingOffset()

irIdEncodingLength

public static int irIdEncodingLength()

irIdMetaAttribute

public static String irIdMetaAttribute(MetaAttribute metaAttribute)

irIdNullValue
```
public static int irIdNullValue()
```

irIdMinValue
```
public static int irIdMinValue()
```

irIdMaxValue
```
public static int irIdMaxValue()
```

irId

public FrameCodecEncoder irId(int value)

irVersionId
```
public static int irVersionId()
```

irVersionSinceVersion

public static int irVersionSinceVersion()

irVersionEncodingOffset

public static int irVersionEncodingOffset()

irVersionEncodingLength

public static int irVersionEncodingLength()

irVersionMetaAttribute

public static String irVersionMetaAttribute(MetaAttribute metaAttribute)

irVersionNullValue

public static int irVersionNullValue()

irVersionMinValue
```
public static int irVersionMinValue()
```

irVersionMaxValue
```
public static int irVersionMaxValue()
```

irVersion

public FrameCodecEncoder irVersion(int value)

schemaVersionId
```
public static int schemaVersionId()
```

schemaVersionSinceVersion

public static int schemaVersionSinceVersion()

schemaVersionEncodingOffset

public static int schemaVersionEncodingOffset()

schemaVersionEncodingLength

public static int schemaVersionEncodingLength()

schemaVersionMetaAttribute

public static String schemaVersionMetaAttribute(MetaAttribute metaAttribute)

schemaVersionNullValue

public static int schemaVersionNullValue()

schemaVersionMinValue

public static int schemaVersionMinValue()

schemaVersionMaxValue

public static int schemaVersionMaxValue()

schemaVersion

public FrameCodecEncoder schemaVersion(int value)

packageNameId
```
public static int packageNameId()
```

packageNameCharacterEncoding

public static String packageNameCharacterEncoding()

packageNameMetaAttribute

public static String packageNameMetaAttribute(MetaAttribute metaAttribute)

packageNameHeaderLength

public static int packageNameHeaderLength()

putPackageName

public FrameCodecEncoder putPackageName(DirectBuffer src,
                                        int srcOffset,
                                        int length)

putPackageName

public FrameCodecEncoder putPackageName(byte[] src,
                                        int srcOffset,
                                        int length)

packageName

public FrameCodecEncoder packageName(String value)

namespaceNameId
```
public static int namespaceNameId()
```

namespaceNameCharacterEncoding

public static String namespaceNameCharacterEncoding()

namespaceNameMetaAttribute

public static String namespaceNameMetaAttribute(MetaAttribute metaAttribute)

namespaceNameHeaderLength

public static int namespaceNameHeaderLength()

putNamespaceName

public FrameCodecEncoder putNamespaceName(DirectBuffer src,
                                          int srcOffset,
                                          int length)

putNamespaceName

public FrameCodecEncoder putNamespaceName(byte[] src,
                                          int srcOffset,
                                          int length)

namespaceName

public FrameCodecEncoder namespaceName(String value)

semanticVersionId
```
public static int semanticVersionId()
```

semanticVersionCharacterEncoding

public static String semanticVersionCharacterEncoding()

semanticVersionMetaAttribute

public static String semanticVersionMetaAttribute(MetaAttribute metaAttribute)

semanticVersionHeaderLength

public static int semanticVersionHeaderLength()

putSemanticVersion

public FrameCodecEncoder putSemanticVersion(DirectBuffer src,
                                            int srcOffset,
                                            int length)

putSemanticVersion

public FrameCodecEncoder putSemanticVersion(byte[] src,
                                            int srcOffset,
                                            int length)

semanticVersion

public FrameCodecEncoder semanticVersion(String value)

toString
```
public String toString()
```
Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

Class FrameCodecEncoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

BYTE_ORDER

initialOffset

offset

limit

Constructor Detail

FrameCodecEncoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

wrapAndApplyHeader

encodedLength

limit

limit

irIdId

irIdSinceVersion

irIdEncodingOffset

irIdEncodingLength

irIdMetaAttribute

irIdNullValue

irIdMinValue

irIdMaxValue

irId

irVersionId

irVersionSinceVersion

irVersionEncodingOffset

irVersionEncodingLength

irVersionMetaAttribute

irVersionNullValue

irVersionMinValue

irVersionMaxValue

irVersion

schemaVersionId

schemaVersionSinceVersion

schemaVersionEncodingOffset

schemaVersionEncodingLength

schemaVersionMetaAttribute

schemaVersionNullValue

schemaVersionMinValue

schemaVersionMaxValue

schemaVersion

packageNameId

packageNameCharacterEncoding

packageNameMetaAttribute

packageNameHeaderLength

putPackageName

putPackageName

packageName

namespaceNameId

namespaceNameCharacterEncoding

namespaceNameMetaAttribute

namespaceNameHeaderLength

putNamespaceName

putNamespaceName

namespaceName

semanticVersionId

semanticVersionCharacterEncoding

semanticVersionMetaAttribute

semanticVersionHeaderLength

putSemanticVersion

putSemanticVersion

semanticVersion

toString

appendTo