org.codice.ddf.libs.klv.data.numerical

Class KlvNumericalDataElement<T extends Number>

java.lang.Object

org.codice.ddf.libs.klv.KlvDataElement<T>

org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement<T>

Direct Known Subclasses:

KlvByte, KlvDouble, KlvFloat, KlvInt, KlvIntegerEncodedFloatingPoint, KlvLong, KlvShort, KlvUnsignedByte, KlvUnsignedShort

public abstract class KlvNumericalDataElement<T extends Number>
extends KlvDataElement<T>

Represents a data element with a numerical value.

Field Summary

Fields

Modifier and Type	Field and Description
protected Optional<T>	errorIndicatorValue

Fields inherited from class org.codice.ddf.libs.klv.KlvDataElement

key, keyBytes, name, value

Constructor Summary

Constructors

Constructor and Description
KlvNumericalDataElement(byte[] key, String name) Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.
KlvNumericalDataElement(byte[] key, String name, Optional<T> errorIndicatorValue) Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.

Method Summary

Modifier and Type	Method and Description
protected abstract KlvNumericalDataElement<T>	copy()
protected abstract void	decodeValue(Klv klv)
boolean	isErrorIndicated() If an error indicator value is present, then compare it to the decoded value.

Methods inherited from class org.codice.ddf.libs.klv.KlvDataElement

getKey, getKeyAsString, getName, getValue

Methods inherited from class java.lang.Object

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

Field Detail

errorIndicatorValue

protected final Optional<T extends Number> errorIndicatorValue

Constructor Detail

KlvNumericalDataElement

public KlvNumericalDataElement(byte[] key,
                               String name)

Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.

Parameters:

key - the data element's key

name - a name describing the data element's value

Throws:

IllegalArgumentException - if any arguments are null

KlvNumericalDataElement

public KlvNumericalDataElement(byte[] key,
                               String name,
                               Optional<T> errorIndicatorValue)

Constructs a KlvNumericalDataElement that describes how to interpret the value of a numerical element with the given key.

Parameters:

key - the data element's key

name - a name describing the data element's value

errorIndicatorValue - value that indicates an encoded error

Throws:

IllegalArgumentException - if any arguments are null

Method Detail

decodeValue

protected abstract void decodeValue(Klv klv)

Specified by:

decodeValue in class KlvDataElement<T extends Number>

copy

protected abstract KlvNumericalDataElement<T> copy()

Specified by:

copy in class KlvDataElement<T extends Number>

isErrorIndicated

public boolean isErrorIndicated()

If an error indicator value is present, then compare it to the decoded value.

Overrides:

isErrorIndicated in class KlvDataElement<T extends Number>

Returns:

true if error was encoded