de.ipcon.tools.date

Enum DurationUnit

java.lang.Object

java.lang.Enum<DurationUnit>

de.ipcon.tools.date.DurationUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DurationUnit>

public enum DurationUnit
extends java.lang.Enum<DurationUnit>

Represents a time unit (year, month, week, day, hour, minute, second) and provides utility methods to extract and work with time units from a Duration object.

This class is designed to handle durations with a single non-zero time unit. Providing a duration with multiple non-zero units will result in an InvalidDurationException.

Note: Weeks are handled as a special case of days (7 days).

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY Represents the "day" time unit.
HOUR Represents the "hour" time unit.
MINUTE Represents the "minute" time unit.
MONTH Represents the "month" time unit.
SECOND Represents the "second" time unit.
WEEK Represents the "week" time unit.
YEAR Represents the "year" time unit.

Method Summary

Modifier and Type	Method and Description
static java.lang.Integer	extractCount(javax.xml.datatype.Duration duration) Extracts the count/value from the given Duration assuming it contains only one "unit part" with a count !
static DurationUnit	fromDesignator(java.lang.String designator) Returns the DurationUnit corresponding to the given designator.
static DurationUnit	fromDuration(javax.xml.datatype.Duration duration) Determines the DurationUnit that corresponds to the single non-zero "unit part" in the given Duration.
static DurationUnit	fromDuration(javax.xml.datatype.Duration duration, DurationUnit defaultUnit) Determines the DurationUnit that corresponds to the single non-zero "unit part" in the given Duration.
static DurationUnit	fromIndex(java.lang.Integer index) Returns the DurationUnit corresponding to the given index.
javax.xml.datatype.Duration	getDuration(int count) Creates a new Duration with the count/value for this DurationUnit set to the given value.
int	getIndex()
java.lang.String	toString()
static DurationUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DurationUnit[]	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

YEAR

public static final DurationUnit YEAR

Represents the "year" time unit.

MONTH

public static final DurationUnit MONTH

Represents the "month" time unit.

WEEK

public static final DurationUnit WEEK

Represents the "week" time unit. Note: Weeks are handled as a special case of days (7 days).

DAY

public static final DurationUnit DAY

Represents the "day" time unit.

HOUR

public static final DurationUnit HOUR

Represents the "hour" time unit.

MINUTE

public static final DurationUnit MINUTE

Represents the "minute" time unit.

SECOND

public static final DurationUnit SECOND

Represents the "second" time unit.

Method Detail

values

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

Returns:

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

valueOf

public static DurationUnit valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DurationUnit>

getIndex

public int getIndex()

extractCount

public static java.lang.Integer extractCount(javax.xml.datatype.Duration duration)

Extracts the count/value from the given Duration assuming it contains only one "unit part" with a count != 0.

Parameters:

duration - The Duration to extract the count from.

Returns:

The extracted count/value, 0 if all counts are 0 or null if the duration is null.

Throws:

InvalidDurationException - If more than one "unit part" has a count/value != 0.

fromDuration

public static DurationUnit fromDuration(javax.xml.datatype.Duration duration)

Determines the DurationUnit that corresponds to the single non-zero "unit part" in the given Duration.

Parameters:

duration - The Duration to determine the unit for.

Returns:

The matching DurationUnit, or DAY if no match is found or the duration is null.

Throws:

InvalidDurationException - If more than one "unit part" has a count/value != 0.

fromDuration

public static DurationUnit fromDuration(javax.xml.datatype.Duration duration,
                                        DurationUnit defaultUnit)

Determines the DurationUnit that corresponds to the single non-zero "unit part" in the given Duration.

Parameters:

duration - The Duration to determine the unit for.

defaultUnit - The default unit to return if no match is found or the duration is null. Defaults to DAY if passed as null.

Returns:

The matching DurationUnit, or defaultUnit if no match is found or the duration is null.

Throws:

InvalidDurationException - If more than one "unit part" has a count/value != 0.

fromDesignator

public static DurationUnit fromDesignator(java.lang.String designator)

Returns the DurationUnit corresponding to the given designator.

Parameters:

designator - the designator

Returns:

the DurationUnit corresponding to the given designator

Throws:

java.lang.IllegalArgumentException - if the designator is invalid

fromIndex

public static DurationUnit fromIndex(java.lang.Integer index)

Returns the DurationUnit corresponding to the given index.

Parameters:

index - the index

Returns:

the DurationUnit corresponding to the given index

Throws:

java.lang.IllegalArgumentException - if the index is invalid

getDuration

public javax.xml.datatype.Duration getDuration(int count)

Creates a new Duration with the count/value for this DurationUnit set to the given value.

Parameters:

count - The count/value to set for this unit.

Returns:

A new Duration with the specified count for this unit.