biz.onixs.sbe

Enum TimestampEpoch

java.lang.Object

java.lang.Enum<TimestampEpoch>

biz.onixs.sbe.TimestampEpoch

All Implemented Interfaces:

Serializable, Comparable<TimestampEpoch>

public enum TimestampEpoch
extends Enum<TimestampEpoch>

Epoch of the SBE timestamp.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Duration The timestamp denotes duration without particular epoch.
Interval The timestamp denotes interval without particular epoch.
Today Today epoch.
Unix Unix epoch.

Method Summary

Modifier and Type	Method and Description
static TimestampEpoch	fromString(String s)
static TimestampEpoch	selectBySpecification(UnifiedMetaData metaData) Select epoch by SBE specification.
static TimestampEpoch	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimestampEpoch[]	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

Unix

public static final TimestampEpoch Unix

Unix epoch. The time is counted since 1 Jan 1970.

Today

public static final TimestampEpoch Today

Today epoch. The time is counted since today 0:00.

Interval

public static final TimestampEpoch Interval

The timestamp denotes interval without particular epoch. May be negative.

Duration

public static final TimestampEpoch Duration

The timestamp denotes duration without particular epoch. Can be only positive (negative values are treated as positive).

Method Detail

values

public static TimestampEpoch[] 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 (TimestampEpoch c : TimestampEpoch.values())
    System.out.println(c);

Returns:

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

valueOf

public static TimestampEpoch 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

selectBySpecification

public static TimestampEpoch selectBySpecification(UnifiedMetaData metaData)

Select epoch by SBE specification.

Parameters:

metaData - SBE metadata that contains epoch specification.

Returns:

chosen epoch.

fromString

public static TimestampEpoch fromString(String s)