UnitValue (Oracle Communications Billing and Revenue Management Elastic Charging Engine Java API Reference)

All Superinterfaces:

java.lang.Comparable<UnitValue>, java.io.Serializable
```
public interface UnitValue>
extends java.lang.Comparable<UnitValue>, java.io.Serializable
```
Represents an association between an Unit and its quantity. For example: 10sec duration, 100KB of data or 2USD. The interface also provides ability to perform mathematical operations between two similar Unit types like adding 100 ms to 3 seconds or 1KB to 120MBs of data with an exception to Money. If mathematical operations between two Units is not supported the method throws a Unit.UnitMisMatchException.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`UnitValue<U>`	`add(UnitValue<U> other)` The method adds the quantities of two UnitValues.
`java.math.BigDecimal`	`getQuantity()` Returns the quantity
`U`	`getUnit()` Returns the Unit
`boolean`	`isZero()` The method returns true if the quantity of this UnitValue is zero.
`UnitValue`	`max(UnitValue otherUnitValue)` compare with the otherUnitValue and return the max
`UnitValue<U>`	`multiply(UnitValue<U> other)` The method multiplies the other UnitValue from this UnitValue.
`UnitValue<U>`	`round(int precision, java.math.RoundingMode mode)` The method rounds the quantity based on the passed precision and the RoundingMode
`UnitValue<U>`	`scale(int scaleValue, java.math.RoundingMode mode)` The method scales the quantity based on the passed scale and the RoundingMode
`UnitValue<U>`	`subtract(UnitValue<U> other)` The method subtracts the other UnitValue from this UnitValue.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
 - isZero
```
boolean isZero()
```
 The method returns true if the quantity of this UnitValue is zero. Returns false otherwise.
 
 Returns:
 
 boolean
 - add
```
UnitValue add(UnitValue other)
```
 The method adds the quantities of two UnitValues. If two UnitValues represent the same Unit type like adding Bytes to KibiBytes or KibiBytes to MebiBytes then the returned UnitValue will have the Unit of lowest common denominator (for example 1KBytes + 1MBytes will return the final quantity in 1025KBytes). The method throws Unit.UnitMisMatchException if two UnitValues cannot be added. A typical scenario would be adding two Money units one being in USD and the other in EUR. Such conversions are not supported and the method will throw UnitMisMatchException.
 
 Parameters:
 
 other - UnitValue The UnitValue to be added
 
 Returns:
 
 UnitValue Added result
 
 Throws:
 
 Unit.UnitMisMatchException - If two Units can not be added.
 - subtract
```
UnitValue subtract(UnitValue other)
```
 The method subtracts the other UnitValue from this UnitValue. If two UnitValues represent the same Unit type like KibiBytes and MebiBytes then the result will be of common denominator Unit type between the two. Hance, 1MBytes - 1KBytes will return 1023KBytes. The method throws Unit.UnitMisMatchException if two UnitValues cannot be subtracted. A typical scenario would be subtracting two Money units one being in USD and the other in EUR. Such conversions are not supported and the method will throw UnitMisMatchException.
 
 Parameters:
 
 other - UnitValue The UnitValue to be subtracted
 
 Returns:
 
 UnitValue The result of the subtraction represented in the common Unit type.
 
 Throws:
 
 Unit.UnitMisMatchException - If the other Unit can not be subtracted.
 - multiply
```
UnitValue multiply(UnitValue other)
```
 The method multiplies the other UnitValue from this UnitValue. If two UnitValues represent the same Unit type like KibiBytes and MebiBytes then the result will be of common denominator Unit type between the two. The method throws Unit.UnitMisMatchException if two UnitValues cannot be multiplied. A typical scenario would be multiplying two Money units one being in USD and the other in EUR. Such conversions are not supported and the method will throw UnitMisMatchException.
 
 Parameters:
 
 other - UnitValue The UnitValue to be multiplied
 
 Returns:
 
 UnitValue The result of the multiplication represented in the common Unit type.
 
 Throws:
 
 Unit.UnitMisMatchException - If the other Unit can not be subtracted.
 - round
```
UnitValue round(int precision,
 java.math.RoundingMode mode)
```
 The method rounds the quantity based on the passed precision and the RoundingMode
 
 Parameters:
 
 precision - int
 
 mode - RoundingMode
 
 Returns:
 
 UnitValue
 - scale
```
UnitValue scale(int scaleValue,
 java.math.RoundingMode mode)
```
 The method scales the quantity based on the passed scale and the RoundingMode
 
 Parameters:
 
 scaleValue - int
 
 mode - RoundingMode
 
 Returns:
 
 UnitValue
 - getQuantity
```
java.math.BigDecimal getQuantity()
```
 Returns the quantity
 
 Returns:
 
 BigDecimal
 - getUnit
```
U getUnit()
```
 Returns the Unit
 
 Returns:
 
 Unit
 - max
```
UnitValue max(UnitValue otherUnitValue)
```
 compare with the otherUnitValue and return the max
 
 Parameters:
 
 otherUnitValue -
 
 Returns:

Interface UnitValue<U extends Unit<U>>

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

isZero

add

subtract

multiply

round

scale

getQuantity

getUnit

max