Package com.storedobject.core

Class TimeDuration

java.lang.Object

com.storedobject.core.Quantity

com.storedobject.core.TimeDuration

All Implemented Interfaces:

Storable, Comparable<Quantity>

public class TimeDuration
extends Quantity

Represents a duration of time as a quantity. This class provides functionality to perform arithmetic operations and format time durations in various string representations. It supports units such as seconds, minutes, hours, and days.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
static final MeasurementUnit	defaultUnit	The default unit of time measurement used in the TimeDuration class.

Fields inherited from class com.storedobject.core.Quantity

PI, PRECISION

Constructor Summary

Constructors

Constructor	Description
TimeDuration()	Default constructor for the TimeDuration class.
TimeDuration(double value, MeasurementUnit unit)	Constructs a TimeDuration instance with the specified value and measurement unit.
TimeDuration(double value, String unit)	Constructs a TimeDuration instance with the specified value and unit.
TimeDuration(double value, TimeUnit unit)	Constructs a TimeDuration instance with the specified numeric value and time unit.
TimeDuration(BigDecimal value, MeasurementUnit unit)	Constructs a TimeDuration instance with the specified value and measurement unit.
TimeDuration(BigDecimal value, String unit)	Constructs a TimeDuration instance using the specified value and unit.
TimeDuration(BigDecimal value, TimeUnit unit)	Constructs a TimeDuration instance with the specified value and time unit.

Method Summary

Modifier and Type	Method	Description
TimeDuration	absolute()	Absolute value of this quantity.
TimeDuration	add(Quantity quantity)	Add quantity
TimeDuration	add(String quantity)	Add quantity value
TimeDuration	add(BigDecimal quantity)	Add quantity
TimeDuration	divide(double divisor)	Divide the quantity with a value
TimeDuration	divide(BigDecimal divisor)	Divide the quantity with a value
String	format()	Format the duration as a string of the form "D days HH:MM:SS".
String	format(boolean allowDays)	Format the duration as a string of the form "D days HH:MM:SS" or "HH:MM:SS".
String	format(boolean allowDays, boolean stripSeconds)	Format the duration as a string of the form "D days HH:MM:SS" or "HH:MM:SS".
TimeDuration	multiply(double multiplicand)	Multiply
TimeDuration	multiply(BigDecimal multiplicand)	Multiply
TimeDuration	negate()	Reverses the sign of this quantity
TimeDuration	subtract(Quantity quantity)	Subtract quantity
TimeDuration	subtract(String quantity)	Subtract quantity
TimeDuration	subtract(BigDecimal quantity)	Subtract quantity
String	toString()	Create the formatted representation of the quantity value with appropriate decimals places.
TimeDuration	zero()	Create a quantity of these types with zero value.

Methods inherited from class com.storedobject.core.Quantity

canConvert, canConvert, canConvert, canConvert, compareTo, convert, convert, convert, convert, convertValue, create, create, create, create, create, create, create, create, create, create, create, create, divide, equals, equalsWhenZero, getClass, getStorableValue, getType, getTypeName, getUnit, getUnit, getUnit, getValue, hashCode, isCompatible, isConvertible, isConvertible, isGreaterThan, isGreaterThan, isGreaterThanOrEqual, isGreaterThanOrEqual, isLessThan, isLessThan, isLessThanOrEqual, isLessThanOrEqual, isNegative, isPositive, isZero, multiply, percentageOf, quantityTypes, round, setUnit, setUnit, sum, toString, toString, toString, types

Methods inherited from class java.lang.Object

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

Field Details

defaultUnit

public static final MeasurementUnit defaultUnit

The default unit of time measurement used in the TimeDuration class. It represents the base unit "second" with a scale factor of 1. This unit is used as a standard reference for converting and performing operations on various time durations within the class.

Constructor Details

TimeDuration

public TimeDuration()

Default constructor for the TimeDuration class. It initializes a TimeDuration object with a value of zero and the default time unit.

TimeDuration

public TimeDuration(double value,
 String unit)

Constructs a TimeDuration instance with the specified value and unit.

Parameters:

value - The numeric value of the time duration to be represented.

unit - The string representation of the time unit (e.g., "seconds", "minutes", "hours").

TimeDuration

public TimeDuration(double value,
 MeasurementUnit unit)

Constructs a TimeDuration instance with the specified value and measurement unit.

Parameters:

value - The numeric value representing the time duration.

unit - The measurement unit for the time duration (e.g., "seconds", "minutes", "hours").

TimeDuration

public TimeDuration(BigDecimal value,
 String unit)

Constructs a TimeDuration instance using the specified value and unit.

Parameters:

value - The numeric value of the time duration to be represented as a BigDecimal.

unit - The string representation of the time unit (e.g., "seconds", "minutes", "hours").

TimeDuration

public TimeDuration(BigDecimal value,
 MeasurementUnit unit)

Constructs a TimeDuration instance with the specified value and measurement unit.

Parameters:

value - The numeric value representing the time duration, provided as a BigDecimal.

unit - The measurement unit for the time duration, represented as a MeasurementUnit object.

TimeDuration

public TimeDuration(double value,
 TimeUnit unit)

Constructs a TimeDuration instance with the specified numeric value and time unit.

Parameters:

value - The numeric value representing the time duration.

unit - The time unit for the duration (e.g., TimeUnit.SECONDS, TimeUnit.MINUTES).

TimeDuration

public TimeDuration(BigDecimal value,
 TimeUnit unit)

Constructs a TimeDuration instance with the specified value and time unit.

Parameters:

value - The numeric value representing the time duration, provided as a BigDecimal.

unit - The time unit for the duration (e.g., TimeUnit.SECONDS, TimeUnit.MINUTES).

Method Details

zero

public TimeDuration zero()

Create a quantity of these types with zero value.

Overrides:

zero in class Quantity

Returns:

Result

add

public TimeDuration add(String quantity)

Add quantity value

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public TimeDuration add(BigDecimal quantity)

Add quantity

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public TimeDuration add(Quantity quantity)

Add quantity

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

subtract

public TimeDuration subtract(String quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public TimeDuration subtract(BigDecimal quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public TimeDuration subtract(Quantity quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

multiply

public TimeDuration multiply(BigDecimal multiplicand)

Multiply

Overrides:

multiply in class Quantity

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public TimeDuration multiply(double multiplicand)

Multiply

Overrides:

multiply in class Quantity

Parameters:

multiplicand - Multiplicand

Returns:

Result

divide

public TimeDuration divide(double divisor)

Divide the quantity with a value

Overrides:

divide in class Quantity

Parameters:

divisor - Divisor

Returns:

Result

divide

public TimeDuration divide(BigDecimal divisor)

Divide the quantity with a value

Overrides:

divide in class Quantity

Parameters:

divisor - Divisor

Returns:

Result

negate

public TimeDuration negate()

Reverses the sign of this quantity

Overrides:

negate in class Quantity

Returns:

Negated value

absolute

public TimeDuration absolute()

Absolute value of this quantity.

Overrides:

absolute in class Quantity

Returns:

Absolute value

toString

public String toString()

Description copied from class: Quantity

Create the formatted representation of the quantity value with appropriate decimals places.

Overrides:

toString in class Quantity

Returns:

The formatted string representation of the quantity.

format

public String format()

Format the duration as a string of the form "D days HH:MM:SS".

Returns:

Formatted string

format

public String format(boolean allowDays)

Format the duration as a string of the form "D days HH:MM:SS" or "HH:MM:SS".

Parameters:

allowDays - Allow days?

Returns:

Formatted string

format

public String format(boolean allowDays,
 boolean stripSeconds)

Format the duration as a string of the form "D days HH:MM:SS" or "HH:MM:SS".

Parameters:

allowDays - Allow days?

stripSeconds - Strip seconds?

Returns:

Formatted string