uk.co.real_logic.artio.builder

Interface Decoder

All Superinterfaces:

CharAppender

All Known Subinterfaces:

AbstractHeartbeatDecoder, AbstractLogonDecoder, AbstractLogoutDecoder, AbstractRejectDecoder, AbstractResendRequestDecoder, AbstractSequenceResetDecoder, AbstractTestRequestDecoder, AbstractUserRequestDecoder

public interface Decoder
extends CharAppender

Parent interface that all Artio decoders implement.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_ERROR

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	appendTo(java.lang.StringBuilder builder, int level) Append a JSON representation of this Decoder value to a StringBuilder object for debugging purposes.
int	decode(AsciiBuffer buffer, int offset, int length)
SessionHeaderDecoder	header() Gets the Header component of this message.
int	invalidTagId() You must call validate() first before relying on the result of this method.
int	rejectReason() You must call validate() first before relying on the result of this method.
void	reset() Resets the result of the decoder.
Encoder	toEncoder(Encoder encoder) Copies the field values on the Encoder to be the same as this Decoder.
boolean	validate() If Validation is switched on then returns it true if the message is valid, false otherwise.

Methods inherited from interface uk.co.real_logic.artio.builder.CharAppender

appendTo

Field Detail

NO_ERROR

static final int NO_ERROR

See Also:

Constant Field Values

Method Detail

decode

int decode(AsciiBuffer buffer,
           int offset,
           int length)

reset

void reset()

Resets the result of the decoder.

validate

boolean validate()

If Validation is switched on then returns it true if the message is valid, false otherwise. If Validation is switched off then the result of this is undefined.

Returns:

true if the message is valid, false otherwise

invalidTagId

int invalidTagId()

You must call validate() first before relying on the result of this method.

Returns:

the tag id of the tag that failed validation, or NO_ERROR if there's no error.

rejectReason

int rejectReason()

You must call validate() first before relying on the result of this method. This method doesn't return an enum in order to avoid cyclic compilation dependencies upon generated enums.

Returns:

the session reject reason error code corresponding to the validation error, or NO_ERROR if there's no error.

header

SessionHeaderDecoder header()

Gets the Header component of this message.

Returns:

the Header component of this message.

appendTo

java.lang.StringBuilder appendTo(java.lang.StringBuilder builder,
                                 int level)

Append a JSON representation of this Decoder value to a StringBuilder object for debugging purposes. Note: there is no guarantee that this internal format will be stable between versions this should only be used for debugging purposes. This should be preferred to Object.toString() because it is a more efficient, zero allocation, method.

Parameters:

builder - the builder to append a JSON string representation to.

level - the whitespace indentation level to use.

Returns:

the builder passed as an argument

toEncoder

Encoder toEncoder(Encoder encoder)

Copies the field values on the Encoder to be the same as this Decoder. This also sets all child components and repeating group values to be the same. This method also resets the encoder before any fields are set so that missing values within the Decoder are also missing within the Encoder. If you wish to copy some of a decoder's fields and set others then the values to be set should be done after this method is called. Care should be taken when using this method - encoders flyweight their String-like fields so the fields of the Decoder will be referenced by the Encoder when

Parameters:

encoder - the encoder to set the values of.

Returns:

the encoder passed as an argument.