TLVElement (KSI SDK 4.19.220 API)

java.lang.Object
- com.guardtime.ksi.tlv.TLVElement

```
public final class TLVElement
extends Object
```
Representation of the Type-Length-Value (TLV) element. The TLV scheme is used to encode both, the KSI data structures and also protocol data units.

For space efficiency, two TLV encodings are used:
- A 16-bit TLV (TLV16) encodes a 13-bit type and 16-bit length (and can thus contain at most 65535 octets of data in the value part).
- An 8-bit TLV (TLV8) encodes a 5-bit type and 8-bit length (at most 255 octets of value data).
TLV header contains 3 flags:
- 16-bit flag. TLV8 and TLV16 are distinguished by the `16-Bit' flag in the first octet of the type field
- The non-critical flag.
- The Forward Unknown flag.

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_TLV16_CONTENT_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`MAX_TLV16_CONTENT_LENGTH`

Constructor Summary

Constructors
Constructor and Description
`TLVElement(boolean inputTlv16, boolean nonCritical, boolean forwarded, int type)`
`TLVElement(boolean nonCritical, boolean forwarded, int type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildElement(TLVElement element)`
`void`	`addFirstChildElement(TLVElement element)`
`static TLVElement`	`create(byte[] bytes)` Creates TLVElement form byte array.
`static TLVElement`	`create(int type, byte[] value)` Creates TLV element with byte array content.
`static TLVElement`	`create(int type, DataHash value)` Creates TLV element with `DataHash` content.
`static TLVElement`	`create(int type, Date value)` Creates TLV element with `Date` content.
`static TLVElement`	`create(int type, HashAlgorithm value)` Creates TLV element with `HashAlgorithm` content.
`static TLVElement`	`create(int type, long value)` Creates TLV element with `Long` content.
`static TLVElement`	`create(int type, String value)` Creates TLV element with `String` content.
`byte[]`	`encodeHeader()` Encodes TLV header.
`boolean`	`equals(Object o)`
`List<TLVElement>`	`getChildElements()`
`List<TLVElement>`	`getChildElements(int... tags)`
`List<TLVElement>`	`getChildElements(int tag)` Returns all the tags with the specified tag.
`byte[]`	`getContent()` Returns the TLV content.
`int`	`getContentLength()`
`DataHash`	`getDecodedDataHash()` Converts TLV element content data to `DataHash` object.
`Date`	`getDecodedDate()` Gets the Date object from TLV element.
`HashAlgorithm`	`getDecodedHashAlgorithm()` Gets HashAlgorithm form TLV element.
`Long`	`getDecodedLong()` This method is used to convert TLV element content data to actual java `Long` object.
`String`	`getDecodedString()` Converts the TLV element content data to UTF-8 string.
`byte[]`	`getEncoded()`
`TLVElement`	`getFirstChildElement()`
`TLVElement`	`getFirstChildElement(int tag)` Returns the first child element with specified tag.
`int`	`getHeaderLength()`
`TLVElement`	`getLastChildElement()`
`int`	`getType()`
`int`	`hashCode()`
`boolean`	`isForwarded()`
`boolean`	`isInputTlv16()`
`boolean`	`isNonCritical()`
`boolean`	`isOutputTlv16()`
`void`	`remove(TLVElement elementToRemoved)`
`void`	`replace(TLVElement childToBeReplaced, TLVElement newChild)` Replaces first element with given one.
`void`	`setContent(byte[] content)` Sets the value to TLV element content.
`void`	`setDataHashContent(DataHash dataHash)`
`void`	`setDateContent(Date date)`
`void`	`setHashAlgorithmContent(HashAlgorithm hashAlgorithm)`
`void`	`setLongContent(long value)`
`void`	`setStringContent(String s)` Encodes the instance of `String`.
`void`	`setType(int type)`
`String`	`toString()`
`void`	`writeTo(OutputStream out)` Writes the encoded TLV element to the specified output stream.

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

- Field Detail
  - MAX_TLV16_CONTENT_LENGTH
```
public static final int MAX_TLV16_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLVElement
```
public TLVElement(boolean nonCritical,
                  boolean forwarded,
                  int type)
```
  - TLVElement
```
public TLVElement(boolean inputTlv16,
                  boolean nonCritical,
                  boolean forwarded,
                  int type)
```
- Method Detail
  - create
```
public static TLVElement create(byte[] bytes)
                         throws TLVParserException
```
    Creates TLVElement form byte array.
    
    Parameters:
    
    bytes - byte array to create the TLV element from.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                long value)
                         throws TLVParserException
```
    Creates TLV element with Long content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                Date value)
                         throws TLVParserException
```
    Creates TLV element with Date content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                DataHash value)
                         throws TLVParserException
```
    Creates TLV element with DataHash content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                String value)
                         throws TLVParserException
```
    Creates TLV element with String content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                byte[] value)
                         throws TLVParserException
```
    Creates TLV element with byte array content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - create
```
public static TLVElement create(int type,
                                HashAlgorithm value)
                         throws TLVParserException
```
    Creates TLV element with HashAlgorithm content. TLV element nonCritical and forwarded flags are set to false.
    
    Parameters:
    
    type - TLV element type.
    
    value - value to be the content of the TLV element.
    
    Returns:
    
    TLVElement
    
    Throws:
    
    TLVParserException
  - getDecodedLong
```
public final Long getDecodedLong()
                          throws TLVParserException
```
    This method is used to convert TLV element content data to actual java Long object.
    
    Returns:
    
    decoded unsigned Long. Value is between 0 - Integer.MAX_VALUE
    
    Throws:
    
    TLVParserException - - content contains leading zeros or content contains more than 63 unsigned bits
  - getDecodedString
```
public final String getDecodedString()
                              throws TLVParserException
```
    Converts the TLV element content data to UTF-8 string.
    
    Returns:
    
    Decoded instance of string.
    
    Throws:
    
    TLVParserException - when content string isn't null terminated or is malformed UTF-8 data.
  - getDecodedDataHash
```
public final DataHash getDecodedDataHash()
                                  throws TLVParserException
```
    Converts TLV element content data to DataHash object.
    
    Returns:
    
    Decoded instance of data hash.
    
    Throws:
    
    TLVParserException - when content can not be decoded to data hash.
  - getDecodedDate
```
public final Date getDecodedDate()
                          throws TLVParserException
```
    Gets the Date object from TLV element.
    
    Returns:
    
    Decoded date object.
    
    Throws:
    
    TLVParserException - when content can not be decoded to a Date object.
  - getDecodedHashAlgorithm
```
public HashAlgorithm getDecodedHashAlgorithm()
                                      throws TLVParserException
```
    Gets HashAlgorithm form TLV element.
    
    Returns:
    
    Instance of HashAlgorithm.
    
    Throws:
    
    TLVParserException
  - getContent
```
public byte[] getContent()
                  throws TLVParserException
```
    Returns the TLV content. If TLV does not include content then empty array is returned.
    
    Returns:
    
    Byte array including TLV element content.
    
    Throws:
    
    TLVParserException
  - setContent
```
public void setContent(byte[] content)
                throws TLVParserException
```
    Sets the value to TLV element content.
    
    Parameters:
    
    content - value to set.
    
    Throws:
    
    TLVParserException
  - setStringContent
```
public void setStringContent(String s)
                      throws TLVParserException
```
    Encodes the instance of String. TLV encoded string is always terminated with a zero octet.
    
    Parameters:
    
    s - string to decode.
    
    Throws:
    
    TLVParserException
  - setLongContent
```
public void setLongContent(long value)
                    throws TLVParserException
```
    Throws:
    
    TLVParserException
  - setDataHashContent
```
public void setDataHashContent(DataHash dataHash)
                        throws TLVParserException
```
    Throws:
    
    TLVParserException
  - setDateContent
```
public void setDateContent(Date date)
                    throws TLVParserException
```
    Throws:
    
    TLVParserException
  - setHashAlgorithmContent
```
public void setHashAlgorithmContent(HashAlgorithm hashAlgorithm)
                             throws TLVParserException
```
    Throws:
    
    TLVParserException
  - getFirstChildElement
```
public TLVElement getFirstChildElement(int tag)
```
    Returns the first child element with specified tag. If tag doesn't exist then null is returned.
    
    Parameters:
    
    tag - tag to search.
    
    Returns:
    
    The first instance of TLVElement with specified tag, or null when the child element with specified tag doesn't exist.
  - getFirstChildElement
```
public TLVElement getFirstChildElement()
```
    Returns:
    
    The first child element, an instance of TLVElement. If current element doesn't contain child elements then null is returned.
  - getLastChildElement
```
public TLVElement getLastChildElement()
```
    Returns:
    
    The last child element, an instance of TLVElement. If current element doesn't contain child elements then null is returned.
  - getChildElements
```
public List<TLVElement> getChildElements(int tag)
```
    Returns all the tags with the specified tag.
    
    Parameters:
    
    tag - tag to search.
    
    Returns:
    
    The list of TLVElement's with specified tag or empty list.
  - getChildElements
```
public List<TLVElement> getChildElements()
```
  - getChildElements
```
public List<TLVElement> getChildElements(int... tags)
```
  - getType
```
public int getType()
```
  - setType
```
public void setType(int type)
```
  - isOutputTlv16
```
public boolean isOutputTlv16()
```
  - isInputTlv16
```
public boolean isInputTlv16()
```
  - isNonCritical
```
public boolean isNonCritical()
```
  - isForwarded
```
public boolean isForwarded()
```
  - encodeHeader
```
public byte[] encodeHeader()
                    throws TLVParserException
```
    Encodes TLV header.
    
    Returns:
    
    Byte array containing encoded TLV header.
    
    Throws:
    
    TLVParserException - when TLV header encoding fails or I/O error occurs.
  - getContentLength
```
public int getContentLength()
```
    Returns:
    
    The length of the TLV element content.
  - getHeaderLength
```
public int getHeaderLength()
```
  - replace
```
public void replace(TLVElement childToBeReplaced,
                    TLVElement newChild)
```
    Replaces first element with given one.
    
    Parameters:
    
    childToBeReplaced - TLV element to be replaced.
    
    newChild - new TLV element.
  - remove
```
public void remove(TLVElement elementToRemoved)
```
  - addChildElement
```
public void addChildElement(TLVElement element)
                     throws TLVParserException
```
    Throws:
    
    TLVParserException
  - addFirstChildElement
```
public void addFirstChildElement(TLVElement element)
                          throws TLVParserException
```
    Throws:
    
    TLVParserException
  - writeTo
```
public void writeTo(OutputStream out)
             throws TLVParserException
```
    Writes the encoded TLV element to the specified output stream.
    
    Parameters:
    
    out - the output stream to which to write the TLV element data.
    
    Throws:
    
    TLVParserException - when I/O error occurred or TLV encoding failed.
  - getEncoded
```
public byte[] getEncoded()
                  throws TLVParserException
```
    Throws:
    
    TLVParserException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class TLVElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_TLV16_CONTENT_LENGTH

Constructor Detail

TLVElement

TLVElement

Method Detail

create

create

create

create

create

create

create

getDecodedLong

getDecodedString

getDecodedDataHash

getDecodedDate

getDecodedHashAlgorithm

getContent

setContent

setStringContent

setLongContent

setDataHashContent

setDateContent

setHashAlgorithmContent

getFirstChildElement

getFirstChildElement

getLastChildElement

getChildElements

getChildElements

getChildElements

getType

setType

isOutputTlv16

isInputTlv16

isNonCritical

isForwarded

encodeHeader

getContentLength

getHeaderLength

replace

remove

addChildElement

addFirstChildElement

writeTo

getEncoded

toString

equals

hashCode