Index (DDF :: KLV 2.31.0 API)

A B C D E F G H I K N O S T V
All Classes and Interfaces|All Packages|Serialized Form

A

addDataElement(KlvDataElement) - Method in class org.codice.ddf.libs.klv.KlvContext: Adds a KlvDataElement to the KlvContext.
addDataElements(Collection<? extends KlvDataElement>) - Method in class org.codice.ddf.libs.klv.KlvContext: Adds multiple KlvDataElements to the KlvContext.

B

BER - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding
bytesToList(byte[], int, int, Klv.KeyLength, Klv.LengthEncoding) - Static method in class org.codice.ddf.libs.klv.data.Klv: Returns a list of KLV sets in the supplied byte array assuming the provided key length and length field encoding.

C

copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvByte
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvDouble
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvFloat
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvInt
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvLong
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvShort
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedByte
copy() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedShort
copy() - Method in class org.codice.ddf.libs.klv.data.raw.KlvBytes
copy() - Method in class org.codice.ddf.libs.klv.data.set.KlvLocalSet
copy() - Method in class org.codice.ddf.libs.klv.data.text.KlvEncodingDetectedString
copy() - Method in class org.codice.ddf.libs.klv.data.text.KlvString
copy() - Method in class org.codice.ddf.libs.klv.KlvDataElement

D

decode(byte[]) - Method in class org.codice.ddf.libs.klv.KlvDecoder: Decodes the KLV data inside klvBytes according to the properties in the KlvContext that was provided in the constructor.
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvByte
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvDouble
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvFloat
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvInt
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvLong
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvShort
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedByte
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedShort
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.raw.KlvBytes
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.set.KlvLocalSet
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.text.KlvEncodingDetectedString
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.data.text.KlvString
decodeValue(Klv) - Method in class org.codice.ddf.libs.klv.KlvDataElement

E

errorIndicatorValue - Variable in class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement

F

FOUR_BYTES - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength
FOUR_BYTES - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding

G

getDataElementByName(String) - Method in class org.codice.ddf.libs.klv.KlvContext: Returns the KlvDataElement in this KlvContext with the given name.
getDataElements() - Method in class org.codice.ddf.libs.klv.KlvContext: Returns the KlvDataElements inside this KlvContext as a Map, where the keys are the data elements' names and the values are the data elements.
getFullKey() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns a byte array representing the key.
getKey() - Method in class org.codice.ddf.libs.klv.KlvDataElement
getKeyAsString() - Method in class org.codice.ddf.libs.klv.KlvDataElement
getKeyLength() - Method in class org.codice.ddf.libs.klv.KlvContext
getLengthEncoding() - Method in class org.codice.ddf.libs.klv.KlvContext
getName() - Method in class org.codice.ddf.libs.klv.KlvDataElement
getValue() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns the value of this KLV set as a copy of the underlying byte array.
getValue() - Method in class org.codice.ddf.libs.klv.KlvDataElement
getValueAs16bitSignedInt() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first two bytes of the value as a 16-bit signed integer.
getValueAs16bitUnsignedInt() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first two bytes of the value as a 16-bit unsigned integer.
getValueAs32bitInt() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first four bytes of the value as a 32-bit int.
getValueAs64bitLong() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first eight bytes of the value as a 64-bit signed long.
getValueAs8bitSignedInt() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first byte of the value as an 8-bit signed integer.
getValueAs8bitUnsignedInt() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns up to the first byte of the value as an 8-bit unsigned integer.
getValueAsDouble() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns the first eight bytes of the value as a double according to IEEE 754 byte packing.
getValueAsFloat() - Method in class org.codice.ddf.libs.klv.data.Klv: Returns the first four bytes of the value as a float according to IEEE 754 byte packing.
getValueAsString(String) - Method in class org.codice.ddf.libs.klv.data.Klv: Return the value as a String interpreted with the given encoding.

H

hasDataElement(String) - Method in class org.codice.ddf.libs.klv.KlvContext: Determines whether this KlvContext contains a KlvDataElement with the given name.

I

isErrorIndicated() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint: If there is a floating point error indicator, then use it.
isErrorIndicated() - Method in class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement: If an error indicator value is present, then compare it to the decoded value.
isErrorIndicated() - Method in class org.codice.ddf.libs.klv.KlvDataElement: If the data element was encoded with an error indicator value and the value matches that indicator, then this method will return true.

K

key - Variable in class org.codice.ddf.libs.klv.KlvDataElement
keyBytes - Variable in class org.codice.ddf.libs.klv.KlvDataElement
Klv - Class in org.codice.ddf.libs.klv.data: A public domain class for working with Key-Length-Value (KLV) byte-packing and unpacking.
Klv.KeyLength - Enum Class in org.codice.ddf.libs.klv.data: The number of bytes in the key field can be one byte, two bytes, four bytes, or sixteen bytes.
Klv.LengthEncoding - Enum Class in org.codice.ddf.libs.klv.data: The encoding style for the length field can be fixed at one byte, two bytes, four bytes, or variable with Basic Encoding Rules (BER).
KlvByte - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV data element that has a byte value.
KlvByte(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvByte: Constructs a KlvByte representing a KLV element that has a byte value.
KlvByte(byte[], String, Optional<Byte>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvByte: Constructs a KlvByte representing a KLV element that has a byte value.
KlvBytes - Class in org.codice.ddf.libs.klv.data.raw: Represents a KLV data element that has a byte[] value.
KlvBytes(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.raw.KlvBytes: Constructs a KlvBytes representing a KLV element that has a byte[] value.
KlvContext - Class in org.codice.ddf.libs.klv: Represents the context used for decoding KLV-encoded data.
KlvContext(Klv.KeyLength, Klv.LengthEncoding) - Constructor for class org.codice.ddf.libs.klv.KlvContext: Constructs a KlvContext containing the properties of a specific KLV-encoded data set.
KlvContext(Klv.KeyLength, Klv.LengthEncoding, Collection<? extends KlvDataElement>) - Constructor for class org.codice.ddf.libs.klv.KlvContext: Constructs a KlvContext containing the properties of a specific KLV-encoded data set, including the data elements that could possibly be found within the data.
KlvDataElement<T> - Class in org.codice.ddf.libs.klv: Describes how to interpret the value of a certain data element.
KlvDataElement(byte[], String) - Constructor for class org.codice.ddf.libs.klv.KlvDataElement: Constructs a KlvDataElement that describes how to interpret the value of a data element with the given key.
KlvDecoder - Class in org.codice.ddf.libs.klv: Decodes bytes that contain KLV-encoded data.
KlvDecoder(KlvContext) - Constructor for class org.codice.ddf.libs.klv.KlvDecoder: Creates a KlvDecoder with the given KlvContext.
KlvDecodingException - Exception Class in org.codice.ddf.libs.klv: Signals that an error has occurred while decoding KLV data.
KlvDecodingException(String) - Constructor for exception class org.codice.ddf.libs.klv.KlvDecodingException
KlvDecodingException(String, Throwable) - Constructor for exception class org.codice.ddf.libs.klv.KlvDecodingException
KlvDouble - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV data element that has a double value.
KlvDouble(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvDouble: Constructs a KlvDouble representing a KLV data element that has a double value.
KlvDouble(byte[], String, Optional<Double>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvDouble: Constructs a KlvDouble representing a KLV data element that has a double value.
KlvEncodingDetectedString - Class in org.codice.ddf.libs.klv.data.text: Represents a KLV data element that has a String value.
KlvEncodingDetectedString(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.text.KlvEncodingDetectedString: Constructs a KlvDataElement that describes how to interpret the value of a data element with the given key.
KlvFloat - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV data element that has a float value.
KlvFloat(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvFloat: Constructs a KlvFloat representing a KLV data element that has a float value.
KlvFloat(byte[], String, Optional<Float>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvFloat: Constructs a KlvFloat representing a KLV data element that has a float value.
KlvInt - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV element that has a int value.
KlvInt(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvInt: Constructs a KlvInt representing a KLV element that has a int value.
KlvInt(byte[], String, Optional<Integer>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvInt: Constructs a KlvInt representing a KLV element that has a int value.
KlvIntegerEncodedFloatingPoint - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV element containing a floating-point value that has been encoded as an integer value.
KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?>, long, long, double, double) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint: Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.
KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?>, long, long, double, double, Optional<Double>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint: Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.
KlvLocalSet - Class in org.codice.ddf.libs.klv.data.set: Represents a KLV element whose value is a chain of KLV data elements.
KlvLocalSet(byte[], String, KlvContext) - Constructor for class org.codice.ddf.libs.klv.data.set.KlvLocalSet: Constructs a KlvLocalSet whose value is a chain of KLV data elements.
KlvLong - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV element that has a long value.
KlvLong(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvLong: Constructs a KlvLong representing a KLV element that has a long value.
KlvLong(byte[], String, Optional<Long>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvLong: Constructs a KlvLong representing a KLV element that has a long value.
KlvNumericalDataElement<T> - Class in org.codice.ddf.libs.klv.data.numerical: Represents a data element with a numerical value.
KlvNumericalDataElement(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement: Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.
KlvNumericalDataElement(byte[], String, Optional<T>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement: Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.
KlvShort - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV data element that has a short value.
KlvShort(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvShort: Constructs a KlvShort representing a KLV data element that has a short value.
KlvShort(byte[], String, Optional<Short>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvShort: Constructs a KlvShort representing a KLV data element that has a short value.
KlvString - Class in org.codice.ddf.libs.klv.data.text: Represents a KLV data element that has a String value.
KlvString(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.text.KlvString: Constructs a KlvString representing a KLV data element that has a String value encoded as UTF-8.
KlvString(byte[], String, String) - Constructor for class org.codice.ddf.libs.klv.data.text.KlvString: Constructs a KlvString representing a KLV data element that has a String value encoded in the given encoding type.
KlvUnsignedByte - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV element that has an unsigned byte value.
KlvUnsignedByte(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedByte: Constructs a KlvUnsignedByte representing a KLV element that has an unsigned byte value.
KlvUnsignedByte(byte[], String, Optional<Short>) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedByte: Constructs a KlvUnsignedByte representing a KLV element that has an unsigned byte value.
KlvUnsignedShort - Class in org.codice.ddf.libs.klv.data.numerical: Represents a KLV element that has an unsigned short value.
KlvUnsignedShort(byte[], String) - Constructor for class org.codice.ddf.libs.klv.data.numerical.KlvUnsignedShort: Constructs a KlvLong representing a KLV element that has an unsigned short value.

N

name - Variable in class org.codice.ddf.libs.klv.KlvDataElement

O

ONE_BYTE - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength
ONE_BYTE - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding
org.codice.ddf.libs.klv - package org.codice.ddf.libs.klv
org.codice.ddf.libs.klv.data - package org.codice.ddf.libs.klv.data
org.codice.ddf.libs.klv.data.numerical - package org.codice.ddf.libs.klv.data.numerical
org.codice.ddf.libs.klv.data.raw - package org.codice.ddf.libs.klv.data.raw
org.codice.ddf.libs.klv.data.set - package org.codice.ddf.libs.klv.data.set
org.codice.ddf.libs.klv.data.text - package org.codice.ddf.libs.klv.data.text

S

SIXTEEN_BYTES - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength

T

TWO_BYTES - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength
TWO_BYTES - Enum constant in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding

V

value - Variable in class org.codice.ddf.libs.klv.KlvDataElement
value() - Method in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength: Returns the number of bytes used in the key.
value() - Method in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding: Returns the number of bytes used to encode length, or zero if encoding is BER
valueOf(String) - Static method in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.codice.ddf.libs.klv.data.Klv.KeyLength: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.codice.ddf.libs.klv.data.Klv.LengthEncoding: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I K N O S T V
All Classes and Interfaces|All Packages|Serialized Form