uk.co.real_logic.artio.fields

Class UtcTimestampEncoder

java.lang.Object

uk.co.real_logic.artio.fields.UtcTimestampEncoder

public final class UtcTimestampEncoder
extends java.lang.Object

An encoder for FIX's Utc timestamp data types. See UtcTimestampDecoder for details of the format.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_WITH_MICROSECONDS
static int	LENGTH_WITH_MILLISECONDS
static int	LENGTH_WITH_NANOSECONDS
static int	LENGTH_WITHOUT_MILLISECONDS
static long	MAX_EPOCH_MICROS
static long	MAX_EPOCH_MILLIS
static long	MAX_EPOCH_NANOS
static long	MIN_EPOCH_MICROS
static long	MIN_EPOCH_MILLIS
static long	MIN_EPOCH_NANOS

Constructor Summary

Constructors

Constructor and Description
UtcTimestampEncoder()
UtcTimestampEncoder(EpochFractionFormat epochFractionPrecision) Create the encoder.

Method Summary

Modifier and Type	Method and Description
byte[]	buffer()
int	encode(long epochFraction) Encode the current time into the buffer as an ascii UTC String
static int	encode(long epochMillis, MutableAsciiBuffer string, int offset)
int	encodeFrom(long duration, java.util.concurrent.TimeUnit timeUnit) Encode the current time into the buffer as an ascii UTC String
static int	encodeMicros(long epochMicros, MutableAsciiBuffer string, int offset)
static int	encodeNanos(long epochNanos, MutableAsciiBuffer string, int offset)
int	initialise(long epochFraction)
int	initialise(long duration, java.util.concurrent.TimeUnit timeUnit)
int	update(long epochFraction) Update the current time into the buffer as an ascii UTC String
int	updateFrom(long duration, java.util.concurrent.TimeUnit timeUnit) Update the current time into the buffer as an ascii UTC String

Methods inherited from class java.lang.Object

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

Field Detail

MIN_EPOCH_MILLIS

public static final long MIN_EPOCH_MILLIS

See Also:

Constant Field Values

MAX_EPOCH_MILLIS

public static final long MAX_EPOCH_MILLIS

See Also:

Constant Field Values

MIN_EPOCH_MICROS

public static final long MIN_EPOCH_MICROS

See Also:

Constant Field Values

MAX_EPOCH_MICROS

public static final long MAX_EPOCH_MICROS

See Also:

Constant Field Values

MIN_EPOCH_NANOS

public static final long MIN_EPOCH_NANOS

See Also:

Constant Field Values

MAX_EPOCH_NANOS

public static final long MAX_EPOCH_NANOS

See Also:

Constant Field Values

LENGTH_WITHOUT_MILLISECONDS

public static final int LENGTH_WITHOUT_MILLISECONDS

See Also:

Constant Field Values

LENGTH_WITH_MILLISECONDS

public static final int LENGTH_WITH_MILLISECONDS

See Also:

Constant Field Values

LENGTH_WITH_MICROSECONDS

public static final int LENGTH_WITH_MICROSECONDS

See Also:

Constant Field Values

LENGTH_WITH_NANOSECONDS

public static final int LENGTH_WITH_NANOSECONDS

See Also:

Constant Field Values

Constructor Detail

UtcTimestampEncoder

public UtcTimestampEncoder()

UtcTimestampEncoder

public UtcTimestampEncoder(EpochFractionFormat epochFractionPrecision)

Create the encoder.

Parameters:

epochFractionPrecision - true if you want to use milliseconds as the precision of the timeunit for the epochFraction passed to encode(). False if you wish to use microseconds.

Method Detail

encodeFrom

public int encodeFrom(long duration,
                      java.util.concurrent.TimeUnit timeUnit)

Encode the current time into the buffer as an ascii UTC String

Parameters:

duration - the current time as the number of specified time unit since the start of the UNIX Epoch.

timeUnit - the TimeUnit of the duration.

Returns:

the length of the encoded data in the flyweight.

encode

public int encode(long epochFraction)

Encode the current time into the buffer as an ascii UTC String

Parameters:

epochFraction - the current time as the number of milliseconds, microseconds or nanoseconds since the start of the UNIX Epoch. The unit of this parameter should align with the constructor parameter EpochFractionFormat.

Returns:

the length of the encoded data in the flyweight.

initialise

public int initialise(long duration,
                      java.util.concurrent.TimeUnit timeUnit)

initialise

public int initialise(long epochFraction)

updateFrom

public int updateFrom(long duration,
                      java.util.concurrent.TimeUnit timeUnit)

Update the current time into the buffer as an ascii UTC String

Parameters:

duration - the current time as the number of specified time unit since the start of the UNIX Epoch.

timeUnit - the TimeUnit of the duration.

Returns:

the length of the encoded data in the flyweight.

update

public int update(long epochFraction)

Update the current time into the buffer as an ascii UTC String

Parameters:

epochFraction - the current time as the number of milliseconds, microseconds or nanoseconds since the start of the UNIX Epoch. The unit of this parameter should align with the constructor parameter EpochFractionFormat.

Returns:

the length of the encoded data in the flyweight.

buffer

public byte[] buffer()

encode

public static int encode(long epochMillis,
                         MutableAsciiBuffer string,
                         int offset)

encodeMicros

public static int encodeMicros(long epochMicros,
                               MutableAsciiBuffer string,
                               int offset)

encodeNanos

public static int encodeNanos(long epochNanos,
                              MutableAsciiBuffer string,
                              int offset)