Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Class TimeValue

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<Time,TimeValue>

org.tquadrat.foundation.value.TimeValue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DimensionedValue<Time>>, Formattable, DimensionedValue<Time>

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

A value class for times, what means periods of time in this case, opposite to the time displayed on the wall-clock.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields inherited from class org.tquadrat.foundation.value.api.ValueBase

DEFAULT_VALIDATOR

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

MATH_CONTEXT

Constructor Summary

Constructors

Constructor	Description
TimeValue(Time dimension, String value)	Creates a new TimeValue instance.
TimeValue(Time dimension, BigDecimal value)	Creates a new TimeValue instance.
TimeValue(Time dimension, Duration value)	Creates a new TimeValue instance.
TimeValue(Time dimension, Period value)	Creates a new TimeValue instance.
TimeValue(Time dimension, N value)	Creates a new TimeValue instance.

Method Summary

Modifier and Type	Method	Description
final Duration	asDuration()	Returns this instance of TimeValue as an instance of Duration.
final TimeValue	clone()	Creates a new copy of this value.
private static final BigDecimal	convertDurationToNanos(Duration duration)	Converts the given instance of Duration to nanoseconds.
final void	formatTo(Formatter formatter, int flags, int width, int precision)
private static final Duration	translatePeriodToDuration(Period period)	Translates a Period instance to a Duration instance.

Methods inherited from class org.tquadrat.foundation.value.api.ValueBase

baseValue, copy, copy, equals, getUnit, hashCode, setUnit, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

baseUnit, compareTo, convert, divide, divide, divide, multiply, multiply, multiply, newInstance, sum, sum, toString, toString, toString, toString, value

Constructor Details

TimeValue

public TimeValue(Time dimension,
 BigDecimal value)

Creates a new TimeValue instance.

Parameters:

dimension - The dimension.

value - The value.

TimeValue

public TimeValue(Time dimension,
 String value)
          throws NumberFormatException

Creates a new TimeValue instance.

Parameters:

dimension - The dimension.

value - The value; it must be possible to parse the given String into a BigDecimal.

Throws:

NumberFormatException - The provided value cannot be converted into a BigDecimal.

TimeValue

public TimeValue(Time dimension,
 N value)

Creates a new TimeValue instance.

Type Parameters:

N - The type of value.

Parameters:

dimension - The dimension.

value - The value.

TimeValue

public TimeValue(Time dimension,
 Duration value)

Creates a new TimeValue instance.

Parameters:

dimension - The dimension.

value - The value.

TimeValue

public TimeValue(Time dimension,
 Period value)

Creates a new TimeValue instance.

Parameters:

dimension - The dimension.

value - The value.

Method Details

asDuration

public final Duration asDuration()

Returns this instance of TimeValue as an instance of Duration.

Returns:

The duration that corresponds to this time value.

clone

public final TimeValue clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<Time>

Overrides:

clone in class ValueBase<Time,TimeValue>

Returns:

The copy.

convertDurationToNanos

private static final BigDecimal convertDurationToNanos(Duration duration)

Converts the given instance of Duration to nanoseconds.

Parameters:

duration - The duration.

Returns:

The nanoseconds value,

formatTo

public final void formatTo(Formatter formatter,
 int flags,
 int width,
 int precision)

The precision is applied to the numerical part only. The width includes the unit symbol, too.

See Also:

• Formatter

translatePeriodToDuration

private static final Duration translatePeriodToDuration(Period period)

Translates a Period instance to a Duration instance.

Parameters:

period - The period to translate.

Returns:

The resulting duration.