jEnumValue
MimeEncodedText
Money
Quantity
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
Class Quantity
Represents the quantity of an item.
Property Summary
| Property | Description |
|---|---|
available: Boolean (read-only) | Identifies if the instance contains settings for value and unit. |
decimalValue: Decimal (read-only) | Returns the quantity as Decimal, null is returned when the quantity is not available. |
unit: String (read-only) | Returns the value for unit which identifies the unit of measure for the quantity. |
value: Number (read-only) | Returns the quantity value. |
Constructor Summary
| Constructor | Description |
|---|---|
| Quantity(Number, String) | Creates a new quantity instance with the specified value and unit. |
Method Summary
| Method | Description |
|---|---|
| add(Quantity) | Add Quantity object to the current object. |
| compareTo(Quantity) | Compares two Quantity values. |
| divide(Number) | Divide Quantity object by specified divisor. |
| equals(Object) | Compares two decimal values whether they are equivalent. |
| getDecimalValue() | Returns the quantity as Decimal, null is returned when the quantity is not available. |
| getUnit() | Returns the value for unit which identifies the unit of measure for the quantity. |
| getValue() | Returns the quantity value. |
| hashCode() | Calculates the hash code for a decimal. |
| isAvailable() | Identifies if the instance contains settings for value and unit. |
| isOfSameUnit(Quantity) | Identifies if two Quantities have the same unit. |
| multiply(Number) | Multiply Quantity object by specified factor. |
| newQuantity(Decimal) | Method returns a new instance of Quantity with the same unit but different value. |
| round(Number) | Rounds the Quantity value to the number of specified decimal digits. |
| subtract(Quantity) | Subtract Quantity object from the current object. |
| toString() | Returns a string representation of this quantity object. |
| valueOf() | According to the ECMA spec returns the “natural” primitive value. |
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Property Details
available
- available: Boolean
(read-only) Identifies if the instance contains settings for value and unit.
decimalValue
- decimalValue: Decimal
(read-only) Returns the quantity as Decimal,
nullis returned when the quantity is not available.
unit
- unit: String
(read-only) Returns the value for unit which identifies the unit of measure for the quantity. Examples of unit are 'inches' or 'pounds'.
value
- value: Number
(read-only) Returns the quantity value.
See Also:
Constructor Details
Quantity(Number, String)
- Quantity(value: Number, unit: String)
Creates a new quantity instance with the specified value and unit.
Parameters:
- value - the actual quantity, must not be
null - unit - the unit identifier for the quantity, must not be
null
- value - the actual quantity, must not be
Method Details
add(Quantity)
- add(value: Quantity): Quantity
Add Quantity object to the current object. Only objects representing the same unit can be added.
Parameters:
- value - Quantity object
Returns:
- Quantity object representing the sum of the operands
compareTo(Quantity)
- compareTo(other: Quantity): Number
Compares two Quantity values. An exception is thrown if the two Quantities values are of different unit. If one of the Quantity values represents the N/A value it is treated as 0.0.
Parameters:
- other - the other quantity to compare.
Returns:
- the comparison.
divide(Number)
- divide(divisor: Number): Quantity
Divide Quantity object by specified divisor.
Parameters:
- divisor - divisor
Returns:
- Quantity object representing division result
equals(Object)
- equals(other: Object): Boolean
Compares two decimal values whether they are equivalent.
Parameters:
- other - the object to compare against this quantity instance.
Returns:
- true if equal, false otherwise.
getDecimalValue()
- getDecimalValue(): Decimal
Returns the quantity as Decimal,
nullis returned when the quantity is not available.Returns:
- the quantity as Decimal
getUnit()
- getUnit(): String
Returns the value for unit which identifies the unit of measure for the quantity. Examples of unit are 'inches' or 'pounds'.
Returns:
- the unit value.
getValue()
- getValue(): Number
Returns the quantity value.
Returns:
- the quantity value.
See Also:
hashCode()
- hashCode(): Number
Calculates the hash code for a decimal.
Returns:
- the hash code.
isAvailable()
- isAvailable(): Boolean
Identifies if the instance contains settings for value and unit.
Returns:
- true if the instance is initialized with value and unit, false if the state is 'not available'.
isOfSameUnit(Quantity)
- isOfSameUnit(value: Quantity): Boolean
Identifies if two Quantities have the same unit.
Parameters:
- value - the second quantity for the comparison.
Returns:
- true if both quantities have the same unit, false otherwise.
multiply(Number)
- multiply(factor: Number): Quantity
Multiply Quantity object by specified factor.
Parameters:
- factor - multiplication factor
Returns:
- Quantity object representing multiplication result
newQuantity(Decimal)
- newQuantity(value: Decimal): Quantity
Method returns a new instance of Quantity with the same unit but different value. An N/A instance is returned if value is null.
Parameters:
- value - as a decimal
Returns:
- new Quantity instance with same unit
round(Number)
- round(precision: Number): Quantity
Rounds the Quantity value to the number of specified decimal digits.
Parameters:
- precision - number of decimal digits after the decimal point
Returns:
- the new rounded Quantity value
subtract(Quantity)
- subtract(value: Quantity): Quantity
Subtract Quantity object from the current object. Only objects representing the same unit can be subtracted.
Parameters:
- value - Quantity object to subtract
Returns:
- Quantity object representing the result of subtraction
toString()
- toString(): String
Returns a string representation of this quantity object.
Returns:
- a string representation of this quantity object.
valueOf()
- valueOf(): Object
According to the ECMA spec returns the "natural" primitive value. Here the value portion of the Quantity is returned.
jDID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!