Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Time

java.lang.Object

java.lang.Enum<Time>

org.tquadrat.foundation.value.Time

All Implemented Interfaces:

Serializable, Comparable<Time>, Constable, Dimension, DimensionWithLinearConversion

@ClassVersion(sourceVersion="$Id: Time.java 1073 2023-10-01 11:08:51Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public enum Time
extends Enum<Time>
implements DimensionWithLinearConversion

The various instances of time periods …

The instance of Time refers to the respective instances of TimeUnit and ChronoUnit wherever possible.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Time.java 1073 2023-10-01 11:08:51Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.Time"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	Time.TemporalUnitImpl	An implementation of TemporalUnit, based on the settings for the Time instance.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BANK_MONTH	A bank month.
BANK_YEAR	A bank year.
CENTURY	A century.
DAY	A day.
DECADE	A decade.
FORTNIGHT	A fortnight (2 weeks or 14 days).
HALF_DAY	Half a day.
HOUR	An hour.
MICROSECOND	A microsecond.
MILLISECOND	A millisecond.
MINUTE	A minute.
MONTH	A month.
NANOSECOND	A nanosecond.
SECOND	A second.
SIMPLE_YEAR	A year.
WEEK	A week (7 days).
YEAR	A tropical year, according to SI.

Field Summary

Fields

Modifier and Type	Field	Description
private final BigDecimal	m_Factor	The factor.
private final Optional<TemporalUnit>	m_TemporalUnit	The time unit as used by the java.time package.
private final TimeUnit	m_TimeUnit	The time unit as used by the java.util.concurrent package.
private final String	m_UnitSymbol	The unit symbol.

Fields inherited from interface org.tquadrat.foundation.value.api.DimensionWithLinearConversion

MSG_UnknownUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Time(BigDecimal factor, String unitSymbol, TimeUnit timeUnit, TemporalUnit temporalUnit)	Creates a new Time instance.

Method Summary

Modifier and Type	Method	Description
protected TemporalUnit	asTemporalUnit()	Returns this instance of Time as an instance of TemporalUnit.
final Time	baseUnit()	Returns the base unit.
final BigDecimal	factor()	Returns the factor that is used to convert a value from this unit to the base unit.
static final Time	forUnit(String unitSymbol)	Returns the Time instance for the given unit.
static final Time	forUnit(ChronoUnit unit)	Returns the Time instance for the given instance of ChronoUnit.
static final Time	forUnit(TemporalUnit unit)	Returns the Time instance for the given instance of TemporalUnit.
static final Time	forUnit(TimeUnit unit)	Returns the Time instance for the given instance of TimeUnit.
final TemporalUnit	getTemporalUnit()	Returns the correspondent TemporalUnit for this instance, as used by the java.time package.
final TimeUnit	getTimeUnit()	Returns the correspondent TimeUnit for this instance, as used by the java.util.concurrent package.
final String	unitSymbol()	Returns the unit symbol for the dimension as a single line string.
static Time	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Time[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tquadrat.foundation.value.api.Dimension

equals, getPrecision, name, toString, unitSymbolForPrinting

Methods inherited from interface org.tquadrat.foundation.value.api.DimensionWithLinearConversion

fromBase, toBase

Enum Constant Details

NANOSECOND

public static final Time NANOSECOND

A nanosecond.

MICROSECOND

public static final Time MICROSECOND

A microsecond.

MILLISECOND

public static final Time MILLISECOND

A millisecond.

SECOND

public static final Time SECOND

A second.

MINUTE

public static final Time MINUTE

A minute.

HOUR

public static final Time HOUR

An hour.

HALF_DAY

public static final Time HALF_DAY

Half a day.

DAY

public static final Time DAY

A day.

WEEK

public static final Time WEEK

A week (7 days).

FORTNIGHT

public static final Time FORTNIGHT

A fortnight (2 weeks or 14 days).

BANK_MONTH

public static final Time BANK_MONTH

A bank month.

This has a fixed length of exact 30 days.

MONTH

public static final Time MONTH

A month.

This is the average month, calculated using the average year with 365.2425 days divided by 12.

BANK_YEAR

public static final Time BANK_YEAR

A bank year.

This has a fixed length of exact 360 days.

YEAR

public static final Time YEAR

A tropical year, according to SI.

See Also:

• CommonConstants.TROPICAL_YEAR

SIMPLE_YEAR

public static final Time SIMPLE_YEAR

A year.

This is calculated as the average year with 365.2425 days.

See Also:

• ChronoUnit.YEARS

DECADE

public static final Time DECADE

A decade.

This is calculated as ten average years with 365.2425 days each.

See Also:

• ChronoUnit.DECADES

CENTURY

public static final Time CENTURY

A century.

This is calculated as one hundred average years with 365.2425 days each.

See Also:

• ChronoUnit.CENTURIES

Field Details

m_Factor

private final BigDecimal m_Factor

The factor.

m_UnitSymbol

private final String m_UnitSymbol

The unit symbol.

m_TemporalUnit

private final Optional<TemporalUnit> m_TemporalUnit

The time unit as used by the java.time package.

m_TimeUnit

private final TimeUnit m_TimeUnit

The time unit as used by the java.util.concurrent package.

Constructor Details

Time

private Time(BigDecimal factor,
 String unitSymbol,
 TimeUnit timeUnit,
 TemporalUnit temporalUnit)

Creates a new Time instance.

Parameters:

factor - The factor.

unitSymbol - The unit symbol.

timeUnit - The time unit as for the java.util.concurrent package; may be null.

temporalUnit - The time unit as for the java.time package; may be null.

Method Details

values

public static Time[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Time valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

asTemporalUnit

protected TemporalUnit asTemporalUnit()

Returns this instance of Time as an instance of TemporalUnit.

Returns:

this as TemporalUnit.

baseUnit

public final Time baseUnit()

Returns the base unit.

E.g. for length, the base unit would be Meter (m), for mass, it is Kilogram (kg), and so on.

Specified by:

baseUnit in interface Dimension

Returns:

The base unit.

factor

public final BigDecimal factor()

Returns the factor that is used to convert a value from this unit to the base unit.

For length, if you have to convert a Centimeter value to Meter, you will divide that by 100 or multiply it with a factor of 0.01.

For the base unit, the factor is 1.0.

Specified by:

factor in interface DimensionWithLinearConversion

Returns:

The factor.

See Also:

• Dimension.baseUnit()

forUnit

public static final Time forUnit(ChronoUnit unit)
                          throws IllegalArgumentException

Returns the Time instance for the given instance of ChronoUnit.

Parameters:

unit - The unit.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

forUnit

public static final Time forUnit(TemporalUnit unit)
                          throws IllegalArgumentException

Returns the Time instance for the given instance of TemporalUnit.

Parameters:

unit - The unit.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

forUnit

public static final Time forUnit(TimeUnit unit)
                          throws IllegalArgumentException

Returns the Time instance for the given instance of TimeUnit.

Parameters:

unit - The unit.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

forUnit

public static final Time forUnit(String unitSymbol)
                          throws IllegalArgumentException

Returns the Time instance for the given unit.

Parameters:

unitSymbol - The unit symbol.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

getTemporalUnit

public final TemporalUnit getTemporalUnit()

Returns the correspondent TemporalUnit for this instance, as used by the java.time package. Because we define here more units as in that package, the return value may be null.

Returns:

The corresponding temporal unit instance, or null if there is no corresponding time unit.

getTimeUnit

public final TimeUnit getTimeUnit()

Returns the correspondent TimeUnit for this instance, as used by the java.util.concurrent package. Because we define here more units as in that package, the return value may be null.

Returns:

The corresponding time unit instance, or null if there is no corresponding time unit.

unitSymbol

public final String unitSymbol()

Returns the unit symbol for the dimension as a single line string.

For a length, this would be "m", for a speed "km/h", and for an acceleration, it could be "m/(s^2)".

Specified by:

unitSymbol in interface Dimension

Returns:

The unit.