org.jpos.tlv

Class TLVList

java.lang.Object

org.jpos.tlv.TLVList

All Implemented Interfaces:

java.io.Serializable, Loggeable

public class TLVList
extends java.lang.Object
implements java.io.Serializable, Loggeable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLVList.TLVListBuilder

Constructor Summary

Constructors

Constructor and Description
TLVList() Creates instance of TLV engine.

Method Summary

Modifier and Type	Method and Description
TLVList	append(int tag, byte[] value) Append TLVMsg to the TLVList.
TLVList	append(int tag, java.lang.String value) Append TLVMsg to the TLVList.
void	append(TLVMsg tlv) Append TLVMsg to the TLV list.
protected TLVMsg	createTLVMsg(int tag, byte[] value) Create TLV message instance.
void	deleteByIndex(int index) delete the specified TLV from the list using a Zero based index
void	deleteByTag(int tag) Delete the specified TLV from the list by tag value
void	dump(java.io.PrintStream p, java.lang.String indent)
java.util.Enumeration<TLVMsg>	elements()
TLVMsg	find(int tag) Searches the list for a specified tag and returns a TLV object.
int	findIndex(int tag) Searches the list for a specified tag and returns a zero based index for that tag.
TLVMsg	findNextTLV() Return the next TLVMsg of same TAG value.
java.lang.String	getString(int tag) searches the list for a specified tag and returns a hex String
java.util.List<TLVMsg>	getTags()
byte[]	getValue(int tag) searches the list for a specified tag and returns it raw
protected int	getValueLength(java.nio.ByteBuffer buffer) Read length bytes and return the int value
boolean	hasTag(int tag) Indicates if TLV measege with passed tag is on list.
TLVMsg	index(int index) Returns a TLVMsg instance stored within the TLVList at the given index.
byte[]	pack() Pack the TLV message (BER-TLV Encoding).
void	unpack(byte[] buf) Unpack a message.
void	unpack(byte[] buf, int offset) Unpack a message with a starting offset.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLVList

public TLVList()

Creates instance of TLV engine.

It is a shorter form of:

   TLVListBuilder.createInstance().build();
 

Method Detail

unpack

public void unpack(byte[] buf)
            throws java.lang.IllegalArgumentException

Unpack a message.

Parameters:

buf - raw message

Throws:

java.lang.IllegalArgumentException

getTags

public java.util.List<TLVMsg> getTags()

Returns:

a list of tags.

elements

public java.util.Enumeration<TLVMsg> elements()

Returns:

an enumeration of the List of tags.

unpack

public void unpack(byte[] buf,
                   int offset)
            throws java.lang.IllegalArgumentException,
                   java.lang.IndexOutOfBoundsException

Unpack a message with a starting offset.

Parameters:

buf - raw message

offset - the offset

Throws:

java.lang.IndexOutOfBoundsException - if offset exceeds {code buf.length}

java.lang.IllegalArgumentException

append

public void append(TLVMsg tlv)
            throws java.lang.NullPointerException

Append TLVMsg to the TLV list.

Parameters:

tlv - the TLV message

Throws:

java.lang.NullPointerException - if tlv is null

append

public TLVList append(int tag,
                      byte[] value)
               throws java.lang.IllegalArgumentException

Append TLVMsg to the TLVList.

Parameters:

tag - tag id

value - tag value

Returns:

the TLV list instance

Throws:

java.lang.IllegalArgumentException - when contains tag with illegal id

append

public TLVList append(int tag,
                      java.lang.String value)
               throws java.lang.IllegalArgumentException

Append TLVMsg to the TLVList.

Parameters:

tag - id

value - in hexadecimal character representation

Returns:

the TLV list instance

Throws:

java.lang.IllegalArgumentException - when contains tag with illegal id

deleteByIndex

public void deleteByIndex(int index)

delete the specified TLV from the list using a Zero based index

Parameters:

index - number

deleteByTag

public void deleteByTag(int tag)

Delete the specified TLV from the list by tag value

Parameters:

tag - id

find

public TLVMsg find(int tag)

Searches the list for a specified tag and returns a TLV object.

Parameters:

tag - id

Returns:

TLV message

findIndex

public int findIndex(int tag)

Searches the list for a specified tag and returns a zero based index for that tag.

Parameters:

tag - tag identifier

Returns:

index for a given tag

findNextTLV

public TLVMsg findNextTLV()
                   throws java.lang.IllegalStateException

Return the next TLVMsg of same TAG value.

Returns:

TLV message or null if not found.

Throws:

java.lang.IllegalStateException - when the search has not been initiated

index

public TLVMsg index(int index)
             throws java.lang.IndexOutOfBoundsException

Returns a TLVMsg instance stored within the TLVList at the given index.

Parameters:

index - zero based index of TLV message

Returns:

TLV message instance

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

pack

public byte[] pack()

Pack the TLV message (BER-TLV Encoding).

Returns:

the packed message

createTLVMsg

protected TLVMsg createTLVMsg(int tag,
                              byte[] value)
                       throws java.lang.IllegalArgumentException

Create TLV message instance.

Parameters:

tag - tag identifier

value - the value of tag

Returns:

TLV message instance

Throws:

java.lang.IllegalArgumentException - when contains tag with illegal id

getValueLength

protected int getValueLength(java.nio.ByteBuffer buffer)
                      throws java.lang.IllegalArgumentException

Read length bytes and return the int value

Parameters:

buffer - buffer

Returns:

value length

Throws:

java.lang.IllegalArgumentException

getString

public java.lang.String getString(int tag)

searches the list for a specified tag and returns a hex String

Parameters:

tag - id

Returns:

hexString

getValue

public byte[] getValue(int tag)

searches the list for a specified tag and returns it raw

Parameters:

tag - id

Returns:

byte[]

hasTag

public boolean hasTag(int tag)

Indicates if TLV measege with passed tag is on list.

Parameters:

tag - tag identifier

Returns:

true if tag contains on list, false otherwise

dump

public void dump(java.io.PrintStream p,
                 java.lang.String indent)

Specified by:

dump in interface Loggeable