biz.onixs.sbe

Enum TimestampUnit

java.lang.Object

java.lang.Enum<TimestampUnit>

biz.onixs.sbe.TimestampUnit

All Implemented Interfaces:

Serializable, Comparable<TimestampUnit>

public enum TimestampUnit
extends Enum<TimestampUnit>

Unit of time for SBE timestamps.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Microseconds Microsecond.
Milliseconds Millisecond.
Nanoseconds Nanosecond.
Seconds Second.

Method Summary

Modifier and Type	Method and Description
String	getFractionFormatLine() Format line for the fraction part.
int	getPrecision() Precision of the unit.
int	getUnitsPerSecond() Number of units per second.
static TimestampUnit	selectByWidth(int width) Select unit by width of the fractional part.
static TimestampUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimestampUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Seconds

public static final TimestampUnit Seconds

Second.

Milliseconds

public static final TimestampUnit Milliseconds

Millisecond.

Microseconds

public static final TimestampUnit Microseconds

Microsecond.

Nanoseconds

public static final TimestampUnit Nanoseconds

Nanosecond.

Method Detail

values

public static TimestampUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimestampUnit c : TimestampUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimestampUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getUnitsPerSecond

public int getUnitsPerSecond()

Number of units per second.

Returns:

Number of units per second.

selectByWidth

public static TimestampUnit selectByWidth(int width)

Select unit by width of the fractional part.

Parameters:

width - width of the fractional part.

Returns:

unit that corresponds to the particular width.

getPrecision

public int getPrecision()

Precision of the unit.

Returns:

precision of the unit.

getFractionFormatLine

public String getFractionFormatLine()

Format line for the fraction part.

Returns:

format line for the fraction part.