TLV (Apache Directory API ASN.1 BER 2.0.1 API)

java.lang.Object
- org.apache.directory.api.asn1.ber.tlv.TLV

```
public class TLV
extends Object
```
This class is used to store Tags, Lengths and Values decoded from a PDU.

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`CONSTRUCTED_FLAG` tag flag for the primitive/constructed bit - 0010 0000 - 0x20
`private int`	`expectedLength` The expected length of the TLV's elements, if the current TLV is a constructed TLV.
`private int`	`id` An identity for the TLV.
`private int`	`length` The current Length being processed
`static int`	`LENGTH_EXTENSION_RESERVED` Value of the reserved extension
`static int`	`LENGTH_LONG_FORM` A mask to get the Length form
`static int`	`LENGTH_SHORT_MASK` A mask to get the long form value
`private int`	`lengthBytesRead` The number of length's bytes currently read
`private int`	`lengthNbBytes` The number of byte to store the Length being processed
`private static byte[][]`	`ONE_BYTE` A speedup for single bytes length
`private TLV`	`parent` Reference the TLV which contains the current TLV, if any.
`static int`	`SHORT_MASK` tag mask for the short tag format - 0001 1111 - 0x1F
`private byte`	`tag` The current Tag being processed
`static byte`	`TYPE_CLASS_MASK` mask to get the type class value
`static byte`	`TYPE_CLASS_UNIVERSAL` value for the universal type class
`private BerValue`	`value` The current Value being processed

Constructor Summary

Constructors
Constructor and Description

TLV(int id)
Creates a new TLV object.

Constructors
Constructor and Description
`TLV(int id)` Creates a new TLV object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`getBytes(int length)` Utility function that return a byte array representing the length
`int`	`getExpectedLength()` Get the TLV expected length.
`int`	`getId()`
`int`	`getLength()`
`int`	`getLengthBytesRead()`
`int`	`getLengthNbBytes()`
`static int`	`getNbBytes(int length)` Utility function that return the number of bytes necessary to store the length
`TLV`	`getParent()`
`int`	`getSize()` The TLV size is calculated by adding the Tag's size, the Length's size and the Value's length, if any.
`byte`	`getTag()`
`BerValue`	`getValue()`
`void`	`incLengthBytesRead()` Increment the number of bytes read for this TLV
`boolean`	`isConstructed()` Checks to see if the current tlv's tag is constructed.
`static boolean`	`isConstructed(byte tag)` Checks to see if the tag is constructed.
`static boolean`	`isPrimitive(byte tag)` Checks to see if the tag represented by this Tag is primitive or constructed.
`static boolean`	`isUniversal(byte tag)` Tells if the tag is Universal or not
`void`	`reset()` Reset the TLV, so it can be reused for the next PDU decoding.
`void`	`setExpectedLength(int expectedLength)` Set the new expected length of the current TLV.
`void`	`setLength(int length)` Set the TLV's length
`void`	`setLengthBytesRead(int lengthBytesRead)` Set the currently read TLV's length bytes.
`void`	`setLengthNbBytes(int lengthNbBytes)` Set the number of bytes we should use to store the TLV's length.
`void`	`setParent(TLV parent)`
`void`	`setTag(byte tag)` Set a tag value for this TLV.
`String`	`toString()` Get a String representation of the TLV

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - tag
```
private byte tag
```
    The current Tag being processed
  - length
```
private int length
```
    The current Length being processed
  - lengthNbBytes
```
private int lengthNbBytes
```
    The number of byte to store the Length being processed
  - lengthBytesRead
```
private int lengthBytesRead
```
    The number of length's bytes currently read
  - value
```
private BerValue value
```
    The current Value being processed
  - id
```
private int id
```
    An identity for the TLV. It store the TLV hashCode
  - parent
```
private TLV parent
```
    Reference the TLV which contains the current TLV, if any. As the enclosing TLV of a PDU does not have parent, it can be null in this case. Otherwise, it must point to a constructed TLV
  - expectedLength
```
private int expectedLength
```
    The expected length of the TLV's elements, if the current TLV is a constructed TLV.
  - CONSTRUCTED_FLAG
```
public static final byte CONSTRUCTED_FLAG
```
    tag flag for the primitive/constructed bit - 0010 0000 - 0x20
    
    See Also:
    
    Constant Field Values
  - TYPE_CLASS_MASK
```
public static final byte TYPE_CLASS_MASK
```
    mask to get the type class value
    
    See Also:
    
    Constant Field Values
  - TYPE_CLASS_UNIVERSAL
```
public static final byte TYPE_CLASS_UNIVERSAL
```
    value for the universal type class
    
    See Also:
    
    Constant Field Values
  - SHORT_MASK
```
public static final int SHORT_MASK
```
    tag mask for the short tag format - 0001 1111 - 0x1F
    
    See Also:
    
    Constant Field Values
  - LENGTH_LONG_FORM
```
public static final int LENGTH_LONG_FORM
```
    A mask to get the Length form
    
    See Also:
    
    Constant Field Values
  - LENGTH_EXTENSION_RESERVED
```
public static final int LENGTH_EXTENSION_RESERVED
```
    Value of the reserved extension
    
    See Also:
    
    Constant Field Values
  - LENGTH_SHORT_MASK
```
public static final int LENGTH_SHORT_MASK
```
    A mask to get the long form value
    
    See Also:
    
    Constant Field Values
  - ONE_BYTE
```
private static final byte[][] ONE_BYTE
```
    A speedup for single bytes length
- Constructor Detail
  - TLV
```
public TLV(int id)
```
    Creates a new TLV object.
    
    Parameters:
    
    id - the TLV's id
- Method Detail
  - isConstructed
```
public static boolean isConstructed(byte tag)
```
    Checks to see if the tag is constructed.
    
    Parameters:
    
    tag - the TLV's tag
    
    Returns:
    
    true if constructed, false if primitive
  - isConstructed
```
public boolean isConstructed()
```
    Checks to see if the current tlv's tag is constructed.
    
    Returns:
    
    true if constructed, false if primitive
  - isPrimitive
```
public static boolean isPrimitive(byte tag)
```
    Checks to see if the tag represented by this Tag is primitive or constructed.
    
    Parameters:
    
    tag - the tag to be checked
    
    Returns:
    
    true if it is primitive, false if it is constructed
  - isUniversal
```
public static boolean isUniversal(byte tag)
```
    Tells if the tag is Universal or not
    
    Parameters:
    
    tag - the tag to be checked
    
    Returns:
    
    true if it is primitive, false if it is constructed
  - reset
```
public void reset()
```
    Reset the TLV, so it can be reused for the next PDU decoding.
  - getTag
```
public byte getTag()
```
    Returns:
    
    Returns the tag.
  - setTag
```
public void setTag(byte tag)
```
    Set a tag value for this TLV.
    
    Parameters:
    
    tag - the tag field for this TLV.
  - getValue
```
public BerValue getValue()
```
    Returns:
    
    Returns the value.
  - getSize
```
public int getSize()
```
    The TLV size is calculated by adding the Tag's size, the Length's size and the Value's length, if any.
    
    Returns:
    
    Returns the size of the TLV.
  - getNbBytes
```
public static int getNbBytes(int length)
```
    Utility function that return the number of bytes necessary to store the length
    
    Parameters:
    
    length - The length to store in a byte array
    
    Returns:
    
    The number of bytes necessary to store the length.
    
    See Also:
    
    X.690
  - getBytes
```
public static byte[] getBytes(int length)
```
    Utility function that return a byte array representing the length
    
    Parameters:
    
    length - The length to store in a byte array
    
    Returns:
    
    The byte array representing the length.
  - getParent
```
public TLV getParent()
```
    Returns:
    
    The parent.
  - setParent
```
public void setParent(TLV parent)
```
    Parameters:
    
    parent - The parent to set.
  - getExpectedLength
```
public int getExpectedLength()
```
    Get the TLV expected length.
    
    Returns:
    
    The expectedLength.
  - setExpectedLength
```
public void setExpectedLength(int expectedLength)
```
    Set the new expected length of the current TLV.
    
    Parameters:
    
    expectedLength - The expectedLength to set.
  - getLengthNbBytes
```
public int getLengthNbBytes()
```
    Returns:
    
    The number of bytes necessary to store the TLV's length
  - setLengthNbBytes
```
public void setLengthNbBytes(int lengthNbBytes)
```
    Set the number of bytes we should use to store the TLV's length.
    
    Parameters:
    
    lengthNbBytes - The number of bytes necessary to store the TLV's length
  - getLength
```
public int getLength()
```
    Returns:
    
    the TLV's length
  - setLength
```
public void setLength(int length)
```
    Set the TLV's length
    
    Parameters:
    
    length - the TLV's length
  - getLengthBytesRead
```
public int getLengthBytesRead()
```
    Returns:
    
    The currently read TLV's length bytes
  - setLengthBytesRead
```
public void setLengthBytesRead(int lengthBytesRead)
```
    Set the currently read TLV's length bytes.
    
    Parameters:
    
    lengthBytesRead - the currently read TLV's length bytes
  - incLengthBytesRead
```
public void incLengthBytesRead()
```
    Increment the number of bytes read for this TLV
  - getId
```
public int getId()
```
    Returns:
    
    The TLV's ID
  - toString
```
public String toString()
```
    Get a String representation of the TLV
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A String

Class TLV

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tag

length

lengthNbBytes

lengthBytesRead

value

id

parent

expectedLength

CONSTRUCTED_FLAG

TYPE_CLASS_MASK

TYPE_CLASS_UNIVERSAL

SHORT_MASK

LENGTH_LONG_FORM

LENGTH_EXTENSION_RESERVED

LENGTH_SHORT_MASK

ONE_BYTE

Constructor Detail

TLV

Method Detail

isConstructed

isConstructed

isPrimitive

isUniversal

reset

getTag

setTag

getValue

getSize

getNbBytes

getBytes

getParent

setParent

getExpectedLength

setExpectedLength

getLengthNbBytes

setLengthNbBytes

getLength

setLength

getLengthBytesRead

setLengthBytesRead

incLengthBytesRead

getId

toString