oracle.communication.brm.charging.util.unit

Enum Duration

java.lang.Object

java.lang.Enum<Duration>

oracle.communication.brm.charging.util.unit.Duration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Duration>, Unit<Duration>

public enum Duration
extends java.lang.Enum<Duration>
implements Unit<Duration>

Represents the time duration unit. Each duration unit has an associated symbol and the supported units are:

1. ms
2. sec
3. min
4. hr
5. Day
6. Week

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.communication.brm.charging.util.unit.Unit

Unit.UnitMisMatchException

Enum Constant Summary

Enum Constants

Enum Constant and Description
Days
Hours
Millis
Minutes
Seconds
Weeks

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<Duration>	ALLOWABLE_DURATION

Fields inherited from interface oracle.communication.brm.charging.util.unit.Unit

MATH_CONTEXT

Method Summary

Modifier and Type	Method and Description
UnitValue<Duration>	convert(UnitValue<Duration> otherValue) Returns an instance of the UnitValue with this Unit converted according to a specific ratio
static UnitValue<Duration>	createValueFromUnitString(java.lang.String unitString, java.math.BigDecimal theValue) helper method used to choose the correct UOM and set the value.
long	getRatio(Duration d) Deprecated.
UnitValue<Duration>	valueOf(java.math.BigDecimal b) Returns an instance of the UnitValue with this Unit and provided quantity
static Duration	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Duration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Millis

public static final Duration Millis

Seconds

public static final Duration Seconds

Minutes

public static final Duration Minutes

Hours

public static final Duration Hours

Days

public static final Duration Days

Weeks

public static final Duration Weeks

Field Detail

ALLOWABLE_DURATION

public static final transient java.util.EnumSet<Duration> ALLOWABLE_DURATION

Method Detail

values

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

Returns:

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

valueOf

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

getRatio

@Deprecated
public long getRatio(Duration d)

Deprecated.

The method returns a negative value if d is smaller than this Unit. For example, if d is Millis and this Unit is in Seconds then the returned value will be 1000. If d is in Seconds and this Unit is in Millis then the returned value is -1000. Negative value is returned to avoid any expensive divisions.

Specified by:

getRatio in interface Unit<Duration>

Parameters:

d - Duration to find the conversion ration with.

Returns:

long The ration between d and this Unit. TODO: this method should be made private, it is still public here to provide backward compatibility to customers who are potentially still using it.

valueOf

public UnitValue<Duration> valueOf(java.math.BigDecimal b)

Returns an instance of the UnitValue with this Unit and provided quantity

Specified by:

valueOf in interface Unit<Duration>

Parameters:

b - BigDecimal

Returns:

UnitValue

convert

public UnitValue<Duration> convert(UnitValue<Duration> otherValue)

Returns an instance of the UnitValue with this Unit converted according to a specific ratio

Specified by:

convert in interface Unit<Duration>

Parameters:

otherValue - UnitValue unit value to convert to

Returns:

UnitValue unit value resulting from conversion of otherValue to the unit

createValueFromUnitString

public static UnitValue<Duration> createValueFromUnitString(java.lang.String unitString,
                                                            java.math.BigDecimal theValue)

helper method used to choose the correct UOM and set the value.

Parameters:

unitString - the UOM for the Data value

theValue - the data value

Returns:

the newly created UnitValue from the supplied values.