Class IF_FSTBINARY

java.lang.Object

org.jpos.iso.ISOFieldPackager

org.jpos.tlv.packager.IF_FSTBINARY

All Implemented Interfaces:

TaggedFieldPackager

public class IF_FSTBINARY
extends ISOFieldPackager
implements TaggedFieldPackager

Field Separator Terminated packager

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
IF_FSTBINARY()	Default constructor.
IF_FSTBINARY(int len, String description)	Constructs a packager with the given length and description.

Method Summary

Modifier and Type	Method	Description
int	getMaxPackedLength()	Returns the maximum number of bytes this packager can produce.
String	getToken()	Returns the tag token for this packager.
byte[]	pack(ISOComponent c)	Packs the given component into a byte array.
void	setToken(String token)	Sets the tag token for this packager.
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)	Unpacks a field from an input stream into the given component.

Methods inherited from class ISOFieldPackager

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

Modifier and Type	Method	Description
ISOComponent	createComponent(int fieldNumber)	Creates an ISOComponent instance appropriate for this packager.
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

IF_FSTBINARY

public IF_FSTBINARY()

Default constructor.

IF_FSTBINARY

public IF_FSTBINARY(int len,
 String description)

Constructs a packager with the given length and description.

Parameters:

len - - field len

description - symbolic descrption

Method Details

setToken

public void setToken(String token)

Description copied from interface: TaggedFieldPackager

Sets the tag token for this packager.

Specified by:

setToken in interface TaggedFieldPackager

Parameters:

token - the tag token

getToken

public String getToken()

Description copied from interface: TaggedFieldPackager

Returns the tag token for this packager.

Specified by:

getToken in interface TaggedFieldPackager

Returns:

the tag token

pack

public byte[] pack(ISOComponent c)
            throws ISOException

Description copied from class: ISOFieldPackager

Packs the given component into a byte array.

Specified by:

pack in class ISOFieldPackager

Parameters:

c - - a component

Returns:

packed component

Throws:

ISOException - on pack/unpack 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 pack/unpack error

unpack

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

Description copied from class: ISOFieldPackager

Unpacks a field from an input stream into the given component.

Overrides:

unpack in class ISOFieldPackager

Parameters:

c - - the Component to unpack

in - - input stream

Throws:

IOException - on I/O failure

ISOException - on unpacking error

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