oracle.communication.brm.charging.util.unit

Enum Occurrence

java.lang.Object

java.lang.Enum<Occurrence>

oracle.communication.brm.charging.util.unit.Occurrence

All Implemented Interfaces:

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

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

Represents the frequency unit. Supported Unit is "Occ".

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
Occ

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<Occurrence>	ALLOWABLE_OCCURENCE

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

MATH_CONTEXT

Method Summary

Modifier and Type	Method and Description
UnitValue<Occurrence>	convert(UnitValue<Occurrence> otherValue) Returns an instance of the UnitValue with this Unit converted according to a specific ratio
static UnitValue<Occurrence>	createValueFromUnitString(java.lang.String unitString, java.math.BigDecimal theValue) helper method used to choose the correct UOM and set the value.
long	getRatio(Occurrence o) Deprecated.
UnitValue<Occurrence>	valueOf(java.math.BigDecimal b) Returns an instance of the UnitValue with this Unit and provided quantity
static Occurrence	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Occurrence[]	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

Occ

public static final Occurrence Occ

Field Detail

ALLOWABLE_OCCURENCE

public static final transient java.util.EnumSet<Occurrence> ALLOWABLE_OCCURENCE

Method Detail

values

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

Returns:

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

valueOf

public static Occurrence 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(Occurrence o)

Deprecated.

Description copied from interface: Unit

NOTE: for backward compatibility, actually obsolete Deprecated, use convert instead The method returns the ratio of numeric conversion between the this and the passed unit. The method throws Unit.UnitMisMatchException if ratio between the two units is not supported.

Specified by:

getRatio in interface Unit<Occurrence>

Parameters:

o - Occurrence Unit

Returns:

long Always returns 1 as occurrence types are not supported. 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<Occurrence> valueOf(java.math.BigDecimal b)

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

Specified by:

valueOf in interface Unit<Occurrence>

Parameters:

b - BigDecimal

Returns:

UnitValue

convert

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

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

Specified by:

convert in interface Unit<Occurrence>

Parameters:

otherValue - UnitValue unit value to convert to

Returns:

UnitValue unit value resulting from conversion of otherValue to the unit

createValueFromUnitString

public static UnitValue<Occurrence> 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:

returns the newly created UnitValue from the supplied values.