Package wt.part

Class Quantity

java.lang.Object

wt.part._Quantity

wt.part.Quantity

All Implemented Interfaces:

Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable

@GenAsObjectMappable(versions=-7293939132854124688L,properties={@GeneratedProperty(name="amount",type=double.class,initialValue="1",supportedAPI=PUBLIC,javaDoc="The amount attributes represents the amount portion of the Quantity.",accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(defaultValue="1")),@GeneratedProperty(name="unit",type=QuantityUnit.class,initialValue="QuantityUnit.EA",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(upperLimit=30,required=true),columnProperties=@ColumnProperties(defaultValue="ea"))})
public final class Quantity
extends _Quantity

This structured attribute class represents the concept of quantity as an _Quantity.amount and a QuantityUnit (unit of measure).

Use the newQuantity static factory method(s), not the Quantity constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.part._Quantity

AMOUNT, UNIT

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if the amount and QuantityUnit are equivalent.
protected void	initialize()	Supports initialization, following construction of an instance.
protected void	initialize(double an_Amount, QuantityUnit a_Unit)	Supports initialization, following construction of an instance.
static Quantity	newQuantity()	Default factory for Quantity.
static Quantity	newQuantity(double an_Amount, QuantityUnit a_Unit)	Quantity factory, allowing construction with a specified amount and unit.

Methods inherited from class wt.part._Quantity

getAmount, getUnit, setAmount, setUnit

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

newQuantity

public static Quantity newQuantity(double an_Amount,
 QuantityUnit a_Unit)
                            throws WTException

Quantity factory, allowing construction with a specified amount and unit.

Supported API: true

Parameters:

an_Amount -

a_Unit -

Returns:

Quantity

Throws:

WTException

initialize

protected void initialize(double an_Amount,
 QuantityUnit a_Unit)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

an_Amount -

a_Unit -

Throws:

WTException

newQuantity

public static Quantity newQuantity()
                            throws WTException

Default factory for Quantity. Defaults the amount to 1 and the unit to "ea".

Supported API: true

Returns:

Quantity

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Throws:

WTException

equals

public boolean equals(Object obj)

Returns true if the amount and QuantityUnit are equivalent. Does not convert from one unit to another.

Supported API: true

Overrides:

equals in class Object

Parameters:

obj - The Quantity object to compare against.

Returns:

boolean