com.cloudhopper.smpp.tlv

Class Tlv

java.lang.Object

com.cloudhopper.smpp.tlv.Tlv

public class Tlv
extends Object

Tag-Length-Value optional parameter in SMPP.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
Tlv(short tag, byte[] value)
Tlv(short tag, byte[] value, String tagName) The tagName is only for logging/debugging by showing up in the toString() method.

Method Summary

Methods

Modifier and Type	Method and Description
int	calculateByteSize() Returns the size of this TLV in bytes.
short	getLength()
short	getTag()
String	getTagName()
int	getUnsignedLength() Gets an "unsigned" version of this TLV's length of its value.
byte[]	getValue()
byte	getValueAsByte() Attempts to get the underlying value as a byte.
int	getValueAsInt() Attempts to get the underlying value as an int.
long	getValueAsLong() Attempts to get the underlying value as a long.
short	getValueAsShort() Attempts to get the underlying value as a short.
String	getValueAsString()
String	getValueAsString(String charsetName)
short	getValueAsUnsignedByte() Attempts to get the underlying value as an unsigned byte.
long	getValueAsUnsignedInt() Attempts to get the underlying value as an unsigned int.
int	getValueAsUnsignedShort() Attempts to get the underlying value as an unsigned short.
void	setTagName(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Tlv

public Tlv(short tag,
   byte[] value)

Tlv

public Tlv(short tag,
   byte[] value,
   String tagName)

The tagName is only for logging/debugging by showing up in the toString() method.

Parameters:

tag -

value -

tagName -

Method Detail

getTagName

public String getTagName()

setTagName

public void setTagName(String value)

getTag

public short getTag()

getUnsignedLength

public int getUnsignedLength()

Gets an "unsigned" version of this TLV's length of its value. A TLV has a 16-bit integer that is encoded as a short. Since Java only has "signed" shorts, any length > 32K would end up being a negative value. This method returns the "unsigned" version as an int.

Returns:

The "unsigned" length of this TLV's value

getLength

public short getLength()

getValue

public byte[] getValue()

calculateByteSize

public int calculateByteSize()

Returns the size of this TLV in bytes. Basically, its always 4 bytes plus the length of the value. Two bytes for tag and two byte for length and then the length of the value itself. Primarily used for encoding the PDU.

Returns:

getValueAsString

public String getValueAsString()
                        throws TlvConvertException

Throws:

TlvConvertException

getValueAsString

public String getValueAsString(String charsetName)
                        throws TlvConvertException

Throws:

TlvConvertException

toString

public String toString()

Overrides:

toString in class Object

getValueAsByte

public byte getValueAsByte()
                    throws TlvConvertException

Attempts to get the underlying value as a byte. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 1, then it cannot be converted to a byte.

Returns:

The byte array value as a byte

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to a byte.

getValueAsUnsignedByte

public short getValueAsUnsignedByte()
                             throws TlvConvertException

Attempts to get the underlying value as an unsigned byte. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 1, then it cannot be converted to an unsigned byte.

Returns:

The byte array value as an unsigned byte

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to an unsigned byte.

getValueAsShort

public short getValueAsShort()
                      throws TlvConvertException

Attempts to get the underlying value as a short. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 2, then it cannot be converted to a short.

Returns:

The byte array value as a short

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to a short.

getValueAsUnsignedShort

public int getValueAsUnsignedShort()
                            throws TlvConvertException

Attempts to get the underlying value as an unsigned short. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 2, then it cannot be converted to an unsigned short.

Returns:

The byte array value as an unsigned short

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to an unsigned short.

getValueAsInt

public int getValueAsInt()
                  throws TlvConvertException

Attempts to get the underlying value as an int. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 4, then it cannot be converted to an int.

Returns:

The byte array value as an int

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to an int.

getValueAsUnsignedInt

public long getValueAsUnsignedInt()
                           throws TlvConvertException

Attempts to get the underlying value as an unsigned int. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 4, then it cannot be converted to an unsigned int.

Returns:

The byte array value as an unsigned int

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to an unsigned int.

getValueAsLong

public long getValueAsLong()
                    throws TlvConvertException

Attempts to get the underlying value as a long. If the underlying byte array cannot be converted, then an exception is thrown. For example, if the underlying byte array isn't a length of 8, then it cannot be converted to a long.

Returns:

The byte array value as a long

Throws:

TlvConvertException - Thrown if the underlying byte array cannot be converted to a long.