com.attivio.sdk.util

Enum TimeResolution

java.lang.Object

java.lang.Enum<TimeResolution>

com.attivio.sdk.util.TimeResolution

All Implemented Interfaces:

Serializable, Comparable<TimeResolution>

public enum TimeResolution
extends Enum<TimeResolution>

Various resolutions for date based operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS Day resolution.
HOURS Hour resolution.
MILLISECONDS Millisecond resolution.
MINUTES Minute Resolution.
SECONDS Second resolution.

Method Summary

Modifier and Type	Method and Description
TimeResolution	parseTimeResolution(String value) Parse value as a TimeResolution value.
abstract long	toMillis(long value) Convert value to milliseconds.
static TimeResolution	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeResolution[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MILLISECONDS

public static final TimeResolution MILLISECONDS

Millisecond resolution.

SECONDS

public static final TimeResolution SECONDS

Second resolution.

MINUTES

public static final TimeResolution MINUTES

Minute Resolution.

HOURS

public static final TimeResolution HOURS

Hour resolution.

DAYS

public static final TimeResolution DAYS

Day resolution.

Method Detail

values

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

Returns:

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

valueOf

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

toMillis

public abstract long toMillis(long value)

Convert value to milliseconds.

parseTimeResolution

public TimeResolution parseTimeResolution(String value)

Parse value as a TimeResolution value.

Returns this if value is null