biz.onixs.util

Class HighResolutionTimestamp

java.lang.Object

biz.onixs.util.HighResolutionTimestamp

All Implemented Interfaces:

Comparable<HighResolutionTimestamp>

public class HighResolutionTimestamp
extends Object
implements Comparable<HighResolutionTimestamp>

High resolution timestamp containing timestamp with millisecond precision and high resolution component with picoseconds precision.

Constructor Summary

Constructors

Constructor and Description
HighResolutionTimestamp()

Method Summary

Modifier and Type	Method and Description
void	assemble(byte[] buffer, int offset, TimestampFormat format) Assemble high resolution timestamp into specified buffer from specified offset with corresponding format.
int	compareTo(HighResolutionTimestamp o)
boolean	equals(Object obj)
Calendar	getCalendar() Returns timestamp without high resolution component of the high resolution timestamp.
long	getPicoSecond() Returns picosecond component of the high resolution timestamp.
static int	getTimestampFormatLength(TimestampFormat format) Retuns length of timestamp corresponding to specified format.
void	parse(byte[] buffer, int offset, int length, TimestampFormat format) Parses timestamp from byte array.
void	setCalendar(Calendar calendar) Sets timestamp without high resolution component of the high resolution timestamp.
void	setPicoSecond(long picoSecond) Sets picosecond component of the high resolution timestamp.
String	toString()
boolean	tryParse(byte[] buffer, int offset, int length, TimestampFormat format) Tries to parse timestamp from byte array.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HighResolutionTimestamp

public HighResolutionTimestamp()

Method Detail

getCalendar

public Calendar getCalendar()

Returns timestamp without high resolution component of the high resolution timestamp.

Returns:

timestamp without high resolution component of the high resolution timestamp

setCalendar

public void setCalendar(Calendar calendar)

Sets timestamp without high resolution component of the high resolution timestamp.

Parameters:

calendar - timestamp without high resolution component to be set

getPicoSecond

public long getPicoSecond()

Returns picosecond component of the high resolution timestamp.

Returns:

picosecond component of the high resolution timestamp

setPicoSecond

public void setPicoSecond(long picoSecond)

Sets picosecond component of the high resolution timestamp.

Parameters:

picoSecond - picoseconds to be set

parse

public void parse(byte[] buffer,
                  int offset,
                  int length,
                  TimestampFormat format)
           throws ParseException

Parses timestamp from byte array.

Parameters:

buffer - source buffer

offset - offset in the source buffer

length - length of the value in the source buffer

format - timestamp format to be parsed

Throws:

NullPointerException - if (null == buffer) or (null == format)

IllegalArgumentException - if (offset < 0) or (offset + length > buffer.length)

ParseException - if byte array can not be parsed with specified format

tryParse

public boolean tryParse(byte[] buffer,
                        int offset,
                        int length,
                        TimestampFormat format)

Tries to parse timestamp from byte array.

Parameters:

buffer - source buffer

offset - offset in the source buffer

length - length of the value in the source buffer

format - timestamp format to be parsed

Returns:

true if timestamp successfully parsed, false otherwise.

Throws:

NullPointerException - if (null == buffer) or (null == format)

IllegalArgumentException - if (offset < 0) or (offset + length > buffer.length)

assemble

public void assemble(byte[] buffer,
                     int offset,
                     TimestampFormat format)

Assemble high resolution timestamp into specified buffer from specified offset with corresponding format.

Parameters:

buffer - buffer to be used for assemble

offset - offset in the buffer to be used

format - format to be used for assemble

Throws:

NullPointerException - if (null == buffer) or (null == format)

IllegalArgumentException - if (offset + [format length] > buffer.length)

getTimestampFormatLength

public static int getTimestampFormatLength(TimestampFormat format)

Retuns length of timestamp corresponding to specified format.

Parameters:

format - format of timestamp

Returns:

length of timestamp corresponding to specified format

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(HighResolutionTimestamp o)

Specified by:

compareTo in interface Comparable<HighResolutionTimestamp>