Class ISOAmount

java.lang.Object

org.jpos.iso.ISOComponent

org.jpos.iso.ISOAmount

All Implemented Interfaces:

Externalizable, Serializable, Cloneable

public class ISOAmount
extends ISOComponent
implements Cloneable, Externalizable

ISO component representing an amount with currency and decimal scale.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ISOAmount()	Default constructor.
ISOAmount(int fieldNumber)	Constructs an ISOAmount for the given field number.
ISOAmount(int fieldNumber, int currencyCode, BigDecimal amount)	Constructs an ISOAmount with all fields.

Method Summary

Modifier and Type	Method	Description
void	dump(PrintStream p, String indent)	Writes a human-readable dump of this component for diagnostics.
boolean	equals(Object o)
BigDecimal	getAmount()	Returns the monetary amount.
String	getAmountAsLegacyString()	Returns the amount formatted as a legacy ISO string.
String	getAmountAsString()	Returns the amount as a formatted string.
int	getCurrencyCode()	Returns the ISO 4217 currency code.
String	getCurrencyCodeAsString()	Returns the currency code as a 3-digit string.
int	getFieldNumber()	Returns the field number this component occupies within its container.
Object	getKey()	valid on Leafs only.
int	getScale()	Returns the decimal scale.
String	getScaleAsString()	Returns the scale as a two-character string.
Object	getValue()	valid on Leafs only.
int	hashCode()
byte[]	pack()	Packs this component into its on-wire byte representation.
void	readExternal(ObjectInput in)
void	setFieldNumber(int fieldNumber)	changes this Component field number Use with care, this method does not change any reference held by a Composite.
void	setValue(Object obj)	Sets the value of this component.
String	toString()
int	unpack(byte[] b)	Unpacks this component from b starting at offset 0.
void	unpack(InputStream in)	Unpacks this component by reading from in.
void	writeExternal(ObjectOutput out)

Methods inherited from class ISOComponent

getBytes, getChildren, getComposite, getMaxField, pack, set, unset

Modifier and Type	Method	Description
byte[]	getBytes()	get Value as bytes (when possible)
Map	getChildren()	dummy behaviour - return empty map
ISOComponent	getComposite()	In order to interchange Composites and Leafs we use getComposite().
int	getMaxField()	a Composite must override this function
void	pack(OutputStream out)	Packs this component and writes it to out.
void	set(ISOComponent c)	Set a field within this message
void	unset(int fldno)	Unset a field

Methods inherited from class Object

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

Constructor Details

ISOAmount

public ISOAmount()

Default constructor.

ISOAmount

public ISOAmount(int fieldNumber)

Constructs an ISOAmount for the given field number.

Parameters:

fieldNumber - the ISO field number

ISOAmount

public ISOAmount(int fieldNumber,
 int currencyCode,
 BigDecimal amount)
          throws ISOException

Constructs an ISOAmount with all fields.

Parameters:

fieldNumber - the ISO field number

currencyCode - the ISO 4217 currency code

amount - the monetary amount

Throws:

ISOException - if the value cannot be encoded

Method Details

getKey

public Object getKey()

Description copied from class: ISOComponent

valid on Leafs only. The value returned is used by ISOMsg as a key to this field.

Overrides:

getKey in class ISOComponent

Returns:

object representing the field number

getValue

public Object getValue()
                throws ISOException

Description copied from class: ISOComponent

valid on Leafs only.

Overrides:

getValue in class ISOComponent

Returns:

object representing the field value

Throws:

ISOException - thrown by composites; leaves return their value

setValue

public void setValue(Object obj)
              throws ISOException

Description copied from class: ISOComponent

Sets the value of this component.

Specified by:

setValue in class ISOComponent

Parameters:

obj - new value

Throws:

ISOException - if the value is rejected by the component implementation

setFieldNumber

public void setFieldNumber(int fieldNumber)

Description copied from class: ISOComponent

changes this Component field number
Use with care, this method does not change any reference held by a Composite.

Specified by:

setFieldNumber in class ISOComponent

Parameters:

fieldNumber - new field number

getFieldNumber

public int getFieldNumber()

Description copied from class: ISOComponent

Returns the field number this component occupies within its container.

Specified by:

getFieldNumber in class ISOComponent

Returns:

the field number

getAmount

public BigDecimal getAmount()

Returns the monetary amount.

Returns:

the amount

getScale

public int getScale()

Returns the decimal scale.

Returns:

the scale

getScaleAsString

public String getScaleAsString()

Returns the scale as a two-character string.

Returns:

scale string

getCurrencyCode

public int getCurrencyCode()

Returns the ISO 4217 currency code.

Returns:

currency code

getCurrencyCodeAsString

public String getCurrencyCodeAsString()
                               throws ISOException

Returns the currency code as a 3-digit string.

Returns:

currency code string

Throws:

ISOException - on error

getAmountAsLegacyString

public String getAmountAsLegacyString()
                               throws ISOException

Returns the amount formatted as a legacy ISO string.

Returns:

formatted amount string

Throws:

ISOException - on error

getAmountAsString

public String getAmountAsString()
                         throws ISOException

Returns the amount as a formatted string.

Returns:

the formatted amount string

Throws:

ISOException - on error

pack

public byte[] pack()
            throws ISOException

Description copied from class: ISOComponent

Packs this component into its on-wire byte representation.

Specified by:

pack in class ISOComponent

Returns:

packed bytes

Throws:

ISOException - if packing fails

unpack

public int unpack(byte[] b)
           throws ISOException

Description copied from class: ISOComponent

Unpacks this component from b starting at offset 0.

Specified by:

unpack in class ISOComponent

Parameters:

b - packed bytes

Returns:

number of bytes consumed

Throws:

ISOException - if unpacking fails

unpack

public void unpack(InputStream in)
            throws ISOException

Description copied from class: ISOComponent

Unpacks this component by reading from in.

Specified by:

unpack in class ISOComponent

Parameters:

in - source stream

Throws:

ISOException - if unpacking fails

dump

public void dump(PrintStream p,
 String indent)

Description copied from class: ISOComponent

Writes a human-readable dump of this component for diagnostics.

Specified by:

dump in class ISOComponent

Parameters:

p - destination stream

indent - prefix to apply to every emitted line

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object