com.paritytrading.philadelphia

Class FIXValue

java.lang.Object

com.paritytrading.philadelphia.FIXValue

public class FIXValue
extends Object

A value container.

Constructor Summary

Constructors

Constructor and Description
FIXValue(int capacity) Construct a new value container.

Method Summary

Modifier and Type	Method and Description
char	asChar() Get the value as a character.
long	asCheckSum() Get the value as a checksum.
void	asDate(org.joda.time.MutableDateTime d) Get the value as a date.
double	asFloat() Get the value as a float.
long	asInt() Get the value as an integer.
String	asString() Get the value as a string.
void	asString(StringBuilder s) Get the value as a string.
void	asTimeOnly(org.joda.time.MutableDateTime t) Get the value as a time only.
void	asTimestamp(org.joda.time.MutableDateTime t) Get the value as a timestamp.
byte	byteAt(int index) Get the byte at the specified index.
void	copyTo(byte[] bytes) Copy the value to a byte array.
boolean	get(ByteBuffer buffer) Read this value from a buffer.
int	length() Get the length of the value.
void	put(ByteBuffer buffer) Write this value to a buffer.
void	reset() Reset the value.
void	set(FIXValue value) Set the value.
void	setChar(char c) Set the value to a character.
void	setCheckSum(long c) Set the value to a checksum.
void	setDate(org.joda.time.ReadableDateTime d) Set the value to a date.
void	setFloat(double f, int decimals) Set the value to a float.
void	setInt(long i) Set the value to an integer.
void	setString(CharSequence s) Set the value to a string.
void	setTimeOnly(org.joda.time.ReadableDateTime t, boolean millis) Set the value to a time only.
void	setTimestamp(org.joda.time.ReadableDateTime t, boolean millis) Set the value to a timestamp.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FIXValue

public FIXValue(int capacity)

Construct a new value container.

Parameters:

capacity - the capacity

Method Detail

byteAt

public byte byteAt(int index)

Get the byte at the specified index. The index must be between 0 and the length of the value - 1.

Parameters:

index - the index

Returns:

the byte at the specified index

Throws:

IndexOutOfBoundsException - if the index is outside of this value container

length

public int length()

Get the length of the value.

Returns:

the length of the value

copyTo

public void copyTo(byte[] bytes)

Copy the value to a byte array.

Parameters:

bytes - a byte array

Throws:

IndexOutOfBoundsException - if the length of the value is greater than the length of the byte array

reset

public void reset()

Reset the value.

set

public void set(FIXValue value)

Set the value.

Parameters:

value - a value container

asChar

public char asChar()

Get the value as a character.

Returns:

the value as a character

Throws:

FIXValueFormatException - if the value is not a character

setChar

public void setChar(char c)

Set the value to a character.

Parameters:

c - a character

asInt

public long asInt()

Get the value as an integer.

Returns:

the value as an integer

Throws:

FIXValueFormatException - if the value is not an integer

setInt

public void setInt(long i)

Set the value to an integer.

Parameters:

i - an integer

asFloat

public double asFloat()

Get the value as a float.

Returns:

the value as a float

Throws:

FIXValueFormatException - if the value is not a float

setFloat

public void setFloat(double f,
                     int decimals)

Set the value to a float.

Parameters:

f - a float

decimals - the number of decimals

asString

public String asString()

Get the value as a string.

Returns:

the value as a string

asString

public void asString(StringBuilder s)

Get the value as a string. The value is appended to the provided string builder.

Parameters:

s - a string builder

setString

public void setString(CharSequence s)

Set the value to a string.

Parameters:

s - a string

Throws:

IndexOutOfBoundsException - if the string is too long

asDate

public void asDate(org.joda.time.MutableDateTime d)

Get the value as a date.

Parameters:

d - a date

Throws:

FIXValueFormatException - if the value is not a date

setDate

public void setDate(org.joda.time.ReadableDateTime d)

Set the value to a date.

Parameters:

d - a date

asTimeOnly

public void asTimeOnly(org.joda.time.MutableDateTime t)

Get the value as a time only.

Parameters:

t - a time only

Throws:

FIXValueFormatException - if the value is not a time only

setTimeOnly

public void setTimeOnly(org.joda.time.ReadableDateTime t,
                        boolean millis)

Set the value to a time only.

Parameters:

t - a time only

millis - if true set milliseconds, otherwise do not set milliseconds

asTimestamp

public void asTimestamp(org.joda.time.MutableDateTime t)

Get the value as a timestamp.

Parameters:

t - a timestamp

Throws:

FIXValueFormatException - if the value is not a timestamp

setTimestamp

public void setTimestamp(org.joda.time.ReadableDateTime t,
                         boolean millis)

Set the value to a timestamp.

Parameters:

t - a timestamp

millis - if true set milliseconds, otherwise do not set milliseconds

asCheckSum

public long asCheckSum()

Get the value as a checksum.

Returns:

the value as a checksum

Throws:

FIXValueFormatException - if the value is not an integer

setCheckSum

public void setCheckSum(long c)

Set the value to a checksum.

Parameters:

c - a checksum

get

public boolean get(ByteBuffer buffer)
            throws FIXValueOverflowException

Read this value from a buffer.

Parameters:

buffer - a buffer

Returns:

true if a value was successfully read from the buffer, otherwise false

Throws:

FIXValueOverflowException - if the length of the value exceeds the capacity of this value container

put

public void put(ByteBuffer buffer)

Write this value to a buffer.

Parameters:

buffer - a buffer

Throws:

BufferOverflowException - if there are fewer bytes remaining in the buffer than what this value consists of

ReadOnlyBufferException - if the buffer is read-only