com.github.signaflo.timeseries

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

com.github.signaflo.timeseries.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

A set of constants representing standard time units, ranging from nanoseconds to centuries. This class wraps a ChronoUnit together with a length of time to create a broader set of time units than those provided by ChronoUnit and to allow additional functionality. For even more fine-tuned time modeling use the TimePeriod class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTURY
DAY
DECADE
HOUR
MICROSECOND
MILLISECOND
MINUTE
MONTH
NANOSECOND
QUARTER
SECOND
WEEK
YEAR

Method Summary

Modifier and Type	Method and Description
double	frequencyPer(TimePeriod timePeriod) Compute and return the number of times this time unit occurs in the given time period.
double	frequencyPer(TimeUnit otherTimeUnit) Compute and return the number of times this time unit occurs in another time unit.
TemporalUnit	temporalUnit() The temporal unit used as the basis for this time unit.
String	toString()
long	unitLength() The length of this time unit relative to the underlying temporal unit.
static TimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeUnit[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CENTURY

public static final TimeUnit CENTURY

DECADE

public static final TimeUnit DECADE

YEAR

public static final TimeUnit YEAR

QUARTER

public static final TimeUnit QUARTER

MONTH

public static final TimeUnit MONTH

WEEK

public static final TimeUnit WEEK

DAY

public static final TimeUnit DAY

HOUR

public static final TimeUnit HOUR

MINUTE

public static final TimeUnit MINUTE

SECOND

public static final TimeUnit SECOND

MILLISECOND

public static final TimeUnit MILLISECOND

MICROSECOND

public static final TimeUnit MICROSECOND

NANOSECOND

public static final TimeUnit NANOSECOND

Method Detail

values

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

Returns:

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

valueOf

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

temporalUnit

public TemporalUnit temporalUnit()

The temporal unit used as the basis for this time unit.

Returns:

the temporal unit used as the basis for this time unit.

unitLength

public long unitLength()

The length of this time unit relative to the underlying temporal unit.

Returns:

the length of this time unit relative to the underlying temporal unit.

frequencyPer

public double frequencyPer(TimeUnit otherTimeUnit)

Compute and return the number of times this time unit occurs in another time unit.

For example, if this time unit is a month and the other time unit is a year, the return value is 12, since a month occurs 12 times in one year.

Parameters:

otherTimeUnit - the time unit for which the frequency of occurrence of this time unit is to be found.

Returns:

the number of times this time unit occurs in the provided time unit.

frequencyPer

public double frequencyPer(TimePeriod timePeriod)

Compute and return the number of times this time unit occurs in the given time period.

For example, if this time unit is a month and the given time period is half a year, the return value is 6, since a month occurs 6 times in one year.

Parameters:

timePeriod - the time period for which the frequency of occurrence of this time unit is to be found.

Returns:

the number of times this time unit occurs in the provided time period.

toString

public String toString()

Overrides:

toString in class Enum<TimeUnit>