biz.onixs.sbe

Class SbeTimestamp

java.lang.Object

biz.onixs.sbe.SbeTimestamp

public class SbeTimestamp
extends Object

SBE timestamp. The class contains data of the SBE timestamps.

Constructor Summary

Constructors

Constructor and Description
SbeTimestamp() Constructs empty object.
SbeTimestamp(long value, TimestampUnit unit, TimestampEpoch epoch, short timezoneHour, short timezoneMinute) Constructs timestamp

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Check two objects for equality.
TimestampEpoch	getEpoch() Timstamp epoch.
short	getTimezoneHour() Timezone hours.
short	getTimezoneMinute() Timezone minutes.
TimestampUnit	getUnit() Unit of the timestamp.
int	getUnitWidth() Width of the unit fraction part (in digits).
long	getValue() Number of units.
int	hashCode() Hashcode.
void	setEpoch(TimestampEpoch epoch) Update timestamp epoch.
void	setTimezoneHour(short timezoneHour) Update timezone hours.
void	setTimezoneMinute(short timezoneMinute) Update timezone minutes.
void	setUnit(TimestampUnit unit) Update unit.
void	setUnitWidth(int unitWidth) Update unit by its precision.
void	setValue(long value) Update the number of units.
String	toString() String presentation of the timestamp.
void	update(long value, TimestampUnit unit, TimestampEpoch epoch, short timezoneHour, short timezoneMinute) Update entire timestamp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SbeTimestamp

public SbeTimestamp()

Constructs empty object. The empty object encodes the '0 milliseconds in unix epoch in UTC'.

SbeTimestamp

public SbeTimestamp(long value,
                    TimestampUnit unit,
                    TimestampEpoch epoch,
                    short timezoneHour,
                    short timezoneMinute)

Constructs timestamp

Parameters:

value - value in units.

unit - unit.

epoch - timestamp epoch.

timezoneHour - hours of timezone.

timezoneMinute - minutes of timezone.

Method Detail

getUnit

public TimestampUnit getUnit()

Unit of the timestamp.

Returns:

unit of the timestamp.

getUnitWidth

public int getUnitWidth()

Width of the unit fraction part (in digits).

Returns:

width of the unit fraction part (in digits).

setUnit

public void setUnit(TimestampUnit unit)

Update unit.

Parameters:

unit - unit of the timestamp.

setUnitWidth

public void setUnitWidth(int unitWidth)

Update unit by its precision.

Parameters:

unitWidth - width of the unit in digits.

getEpoch

public TimestampEpoch getEpoch()

Timstamp epoch.

Returns:

epoch of the timestamp.

setEpoch

public void setEpoch(TimestampEpoch epoch)

Update timestamp epoch.

Parameters:

epoch - - epoch of the timestamp.

getValue

public long getValue()

Number of units.

Returns:

number of units in the timestamp.

setValue

public void setValue(long value)

Update the number of units.

Parameters:

value - number of units in the timestamp.

getTimezoneMinute

public short getTimezoneMinute()

Timezone minutes.

Returns:

number of minutes in the timezone of the timestamp if the timestamp has appropriate specification. The default value is 0 (zero).

setTimezoneMinute

public void setTimezoneMinute(short timezoneMinute)

Update timezone minutes.

Parameters:

timezoneMinute - minutes of the timezone.

getTimezoneHour

public short getTimezoneHour()

Timezone hours.

Returns:

number of hours in the timezone of the timestamp if the timestamp has appropriate specification. The default value is 0 (zero).

setTimezoneHour

public void setTimezoneHour(short timezoneHour)

Update timezone hours.

Parameters:

timezoneHour - number of hours in the timezone of the timestamp.

update

public void update(long value,
                   TimestampUnit unit,
                   TimestampEpoch epoch,
                   short timezoneHour,
                   short timezoneMinute)

Update entire timestamp

Parameters:

value - value in units.

unit - unit.

epoch - timestamp epoch.

timezoneHour - hours of timezone.

timezoneMinute - minutes of timezone.

toString

public String toString()

String presentation of the timestamp. Timestamp is returned in the FIX form: [YYYYMMDDT]HH:MM:SS[.ssssss]Timezone. - The fraction part width is specified by the 'unit' property of the object. - The date part appear only when the epoch is Unix. - The Timezone is exposed as 'TZ' or 'Z[+/-]mm:ss'.

Overrides:

toString in class Object

Returns:

FIX-aware timestamp.

equals

public boolean equals(Object o)

Check two objects for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Hashcode.

Overrides:

hashCode in class Object