Class ISOBinaryField

java.lang.Object

org.jpos.iso.ISOComponent

org.jpos.iso.ISOBinaryField

All Implemented Interfaces:

Externalizable, Serializable, Cloneable

public class ISOBinaryField
extends ISOComponent
implements Cloneable, Externalizable

implements Leaf for binary fields See the API User's Guide for details.

See Also:

• ISOComponent
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	fieldNumber	The ISO field number.
protected byte[]	value	The raw binary value.

Constructor Summary

Constructors

Constructor	Description
ISOBinaryField()	No args constructor (required by Externalizable support on ISOMsg)
ISOBinaryField(int n)	Constructs a binary field with the given field number.
ISOBinaryField(int n, byte[] v)	Constructs a binary field.
ISOBinaryField(int n, byte[] v, int offset, int len)	Constructs a binary field.

Method Summary

Modifier and Type	Method	Description
void	dump(PrintStream p, String indent)	dump this field to PrintStream.
byte[]	getBytes()	get Value as bytes (when possible)
int	getFieldNumber()	Returns the field number this component occupies within its container.
Object	getKey()	valid on Leafs only.
Object	getValue()	valid on Leafs only.
byte[]	pack()	not available on Leaf - always throw ISOException
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)	not available on Leaf - always throw ISOException
void	unpack(InputStream in)	not available on Leaf - always throw ISOException
void	writeExternal(ObjectOutput out)

Methods inherited from class ISOComponent

getChildren, getComposite, getMaxField, pack, set, unset

Modifier and Type	Method	Description
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

fieldNumber

protected int fieldNumber

The ISO field number.

value

protected byte[] value

The raw binary value.

Constructor Details

ISOBinaryField

public ISOBinaryField()

No args constructor (required by Externalizable support on ISOMsg)

ISOBinaryField

public ISOBinaryField(int n)

Constructs a binary field with the given field number.

Parameters:

n - - the FieldNumber

ISOBinaryField

public ISOBinaryField(int n,
 byte[] v)

Constructs a binary field.

Parameters:

n - - fieldNumber

v - - fieldValue

ISOBinaryField

public ISOBinaryField(int n,
 byte[] v,
 int offset,
 int len)

Constructs a binary field.

Parameters:

n - - fieldNumber

v - - fieldValue

offset - - starting offset

len - - field length

Method Details

setFieldNumber

public void setFieldNumber(int fieldNumber)

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

pack

public byte[] pack()
            throws ISOException

not available on Leaf - always throw ISOException

Specified by:

pack in class ISOComponent

Returns:

packed bytes

Throws:

ISOException - on ISO processing error

unpack

public int unpack(byte[] b)
           throws ISOException

not available on Leaf - always throw ISOException

Specified by:

unpack in class ISOComponent

Parameters:

b - packed bytes

Returns:

number of bytes consumed

Throws:

ISOException - on ISO processing error

unpack

public void unpack(InputStream in)
            throws ISOException

not available on Leaf - always throw ISOException

Specified by:

unpack in class ISOComponent

Parameters:

in - source stream

Throws:

ISOException - on ISO processing error

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 this field number

getValue

public Object getValue()

Description copied from class: ISOComponent

valid on Leafs only.

Overrides:

getValue in class ISOComponent

Returns:

Object representing this field 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 - - Object representing this field value

Throws:

ISOException - on ISO processing error

getBytes

public byte[] getBytes()

Description copied from class: ISOComponent

get Value as bytes (when possible)

Overrides:

getBytes in class ISOComponent

Returns:

byte[] representing this field

dump

public void dump(PrintStream p,
 String indent)

dump this field to PrintStream. The output is sorta XML, intended to be easily parsed.

Specified by:

dump in class ISOComponent

Parameters:

p - - print stream

indent - - optional indent string

toString

public String toString()

Overrides:

toString in class Object

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