Class ISOBinaryFieldPackager

java.lang.Object

org.jpos.iso.ISOFieldPackager

org.jpos.iso.ISOBinaryFieldPackager

Direct Known Subclasses:

IF_FBINARY, IFA_BINARY, IFA_LBINARY, IFA_LLBINARY, IFA_LLLBINARY, IFA_LLLLBINARY, IFA_LLLLLBINARY, IFA_LLLLLLBINARY, IFB_BINARY, IFB_LHBINARY, IFB_LLBINARY, IFB_LLHBINARY, IFB_LLHEX, IFB_LLLBINARY, IFB_LLLHBINARY, IFB_LLLHEX, IFB_LLLLBINARY, IFE_BINARY, IFE_LBINARY, IFE_LLBINARY, IFE_LLLBINARY, IFE_LLLEBINARY, IFE_LLLLBINARY, IFEP_LLLBINARY, ISOTagBinaryFieldPackager

public class ISOBinaryFieldPackager
extends ISOFieldPackager

Marker interface for ISOFieldPackager implementations that handle binary fields.

Field Summary

Fields inherited from class ISOFieldPackager

pad, trim

Modifier and Type	Field	Description
protected boolean	pad	When true, values are padded to the field length.
protected boolean	trim	When true, values are trimmed before packing.

Constructor Summary

Constructors

Constructor	Description
ISOBinaryFieldPackager()	Constructs a default ISOBinaryFieldPackager.
ISOBinaryFieldPackager(int maxLength, String description, BinaryInterpreter interpreter, Prefixer prefixer)	Creates an ISOBinaryFieldPackager.
ISOBinaryFieldPackager(BinaryInterpreter interpreter, Prefixer prefixer)	Creates an ISOBinaryFieldPackager.

Method Summary

Modifier and Type	Method	Description
protected void	checkLength(int len, int maxLength)	Checks the length of the data against the maximum, and throws an IllegalArgumentException.
ISOComponent	createComponent(int fieldNumber)	component factory
int	getMaxPackedLength()	Returns the maximum number of bytes this packager can produce.
byte[]	pack(ISOComponent c)	Convert the component into a byte[].
void	setInterpreter(BinaryInterpreter interpreter)	Sets the Interpreter.
void	setPrefixer(Prefixer prefixer)	Sets the length prefixer.
int	unpack(ISOComponent c, byte[] b, int offset)	Unpacks a field from the binary image into the given component.
void	unpack(ISOComponent c, InputStream in)	Unpack from an input stream

Methods inherited from class ISOFieldPackager

getDescription, getLength, pack, readBytes, setDescription, setLength, setPad, setTrim

Modifier and Type	Method	Description
String	getDescription()	Returns the field description.
int	getLength()	Returns the maximum field length.
void	pack(ISOComponent c, ObjectOutput out)	Packs the component to an ObjectOutput stream.
protected byte[]	readBytes(InputStream in, int l)	Reads exactly l bytes from the input stream.
void	setDescription(String description)	Sets the field description.
void	setLength(int len)	Sets the maximum field length.
void	setPad(boolean pad)	Enables or disables padding for this field.
void	setTrim(boolean trim)	Enables or disables trimming for this field.

Methods inherited from class Object

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

Constructor Details

ISOBinaryFieldPackager

public ISOBinaryFieldPackager()

Constructs a default ISOBinaryFieldPackager. There is no length prefix and a literal interpretation. The set methods must be called to make this ISOBinaryFieldPackager useful.

ISOBinaryFieldPackager

public ISOBinaryFieldPackager(int maxLength,
 String description,
 BinaryInterpreter interpreter,
 Prefixer prefixer)

Creates an ISOBinaryFieldPackager.

Parameters:

maxLength - The maximum length of the field in characters or bytes depending on the datatype.

description - The description of the field. For human readable output.

interpreter - The interpreter used to encode the field.

prefixer - The type of length prefixer used to encode this field.

ISOBinaryFieldPackager

public ISOBinaryFieldPackager(BinaryInterpreter interpreter,
 Prefixer prefixer)

Creates an ISOBinaryFieldPackager.

Parameters:

interpreter - The interpreter used to encode the field.

prefixer - The type of length prefixer used to encode this field.

Method Details

setInterpreter

public void setInterpreter(BinaryInterpreter interpreter)

Sets the Interpreter.

Parameters:

interpreter - The interpreter to use in packing and unpacking.

setPrefixer

public void setPrefixer(Prefixer prefixer)

Sets the length prefixer.

Parameters:

prefixer - The length prefixer to use during packing and unpacking.

getMaxPackedLength

public int getMaxPackedLength()

Description copied from class: ISOFieldPackager

Returns the maximum number of bytes this packager can produce.

Specified by:

getMaxPackedLength in class ISOFieldPackager

Returns:

maximum packed length in bytes

pack

public byte[] pack(ISOComponent c)
            throws ISOException

Convert the component into a byte[].

Specified by:

pack in class ISOFieldPackager

Parameters:

c - - a component

Returns:

packed component

Throws:

ISOException - on packing error

unpack

public int unpack(ISOComponent c,
 byte[] b,
 int offset)
           throws ISOException

Description copied from class: ISOFieldPackager

Unpacks a field from the binary image into the given component.

Specified by:

unpack in class ISOFieldPackager

Parameters:

c - - the Component to unpack

b - - binary image

offset - - starting offset within the binary image

Returns:

consumed bytes

Throws:

ISOException - on unpacking error

unpack

public void unpack(ISOComponent c,
 InputStream in)
            throws IOException,
ISOException

Unpack from an input stream

Overrides:

unpack in class ISOFieldPackager

Parameters:

c - - the Component to unpack

in - - input stream

Throws:

IOException - on I/O failure

ISOException - on unpacking error

createComponent

public ISOComponent createComponent(int fieldNumber)

component factory

Overrides:

createComponent in class ISOFieldPackager

Parameters:

fieldNumber - - the field number

Returns:

the newly created component

checkLength

protected void checkLength(int len,
 int maxLength)
                    throws IllegalArgumentException

Checks the length of the data against the maximum, and throws an IllegalArgumentException. This is designed to be called from field Packager constructors and the setLength() method.

Parameters:

len - The length of the data for this field packager.

maxLength - The maximum length allowed for this type of field packager. This depends on the prefixer that is used.

Throws:

IllegalArgumentException - If len > maxLength.