org.jmisb.api.klv.st1903

Class Security

java.lang.Object

org.jmisb.api.klv.st1903.Security

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IMimdMetadataValue

@Beta
public class Security
extends Object
implements IMimdMetadataValue, INestedKlvValue

Security Local Set. See ST1903 for more information on this data type.

Constructor Summary

Constructors

Constructor and Description
Security() Create a new empty Security local set.
Security(byte[] bytes) Construct Security Local Set from encoded bytes.
Security(byte[] data, int offset, int numBytes) Build a Security Local Set from encoded bytes.
Security(Map<SecurityMetadataKey,IMimdMetadataValue> values) Create the Security local set from the given key/value pairs.

Method Summary

Modifier and Type	Method and Description
static Security	fromBytes(byte[] bytes) Create Security Local Set from encoded bytes.
byte[]	getBytes() Get the encoded bytes.
Security_Classification	getClassification() Get the classification attribute value.
Security_ClassifyingMethod	getClassifyingMethod() Get the classifyingMethod attribute value.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
IKlvValue	getField(IKlvKey tag) Get the value of a given item.
Set<? extends IKlvKey>	getIdentifiers() Get the set of identifiers for populated values.
MimdId	getMimdId() Get the mimdId attribute value.
NumericalPrecision	getNumericPrecision() Get the numericPrecision attribute value.
MimdIdReference	getSecurity() Get the security attribute value.
MimdIdReference	getTimer() Get the timer attribute value.
Base_TimerOffset	getTimerOffset() Get the timerOffset attribute value.
void	setClassification(Security_Classification classification) Set the classification attribute value.
void	setClassifyingMethod(Security_ClassifyingMethod classifyingMethod) Set the classifyingMethod attribute value.
void	setMimdId(MimdId mimdId) Set the mimdId attribute value.
void	setNumericPrecision(NumericalPrecision numericPrecision) Set the numericPrecision attribute value.
void	setSecurity(MimdIdReference security) Set the security attribute value.
void	setTimer(MimdIdReference timer) Set the timer attribute value.
void	setTimerOffset(Base_TimerOffset timerOffset) Set the timerOffset attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Security

public Security()

Create a new empty Security local set.

Security

public Security(Map<SecurityMetadataKey,IMimdMetadataValue> values)

Create the Security local set from the given key/value pairs.

Parameters:

values - Tag/value pairs to be included in the local set

Security

public Security(byte[] data,
                int offset,
                int numBytes)
         throws KlvParseException

Build a Security Local Set from encoded bytes.

Parameters:

data - the bytes to build from.

offset - the offset into bytes to start parsing from.

numBytes - the number of bytes to parse.

Throws:

KlvParseException - if parsing fails (depending on InvalidDataHandler strategy)

Security

public Security(byte[] bytes)
         throws KlvParseException

Construct Security Local Set from encoded bytes.

Parameters:

bytes - Encoded byte array.

Throws:

KlvParseException - if the array could not be parsed

Method Detail

getMimdId

public MimdId getMimdId()

Get the mimdId attribute value.

Returns:

a MimdId value, or null if not set.

setMimdId

public void setMimdId(MimdId mimdId)

Set the mimdId attribute value.

Parameters:

mimdId - the MimdId value to set.

getTimer

public MimdIdReference getTimer()

Get the timer attribute value.

Returns:

a MimdIdReference value, or null if not set.

setTimer

public void setTimer(MimdIdReference timer)

Set the timer attribute value.

Parameters:

timer - the MimdIdReference value to set.

getTimerOffset

public Base_TimerOffset getTimerOffset()

Get the timerOffset attribute value.

Returns:

a org.jmisb.api.klv.st1904.Base_TimerOffset value, or null if not set.

setTimerOffset

public void setTimerOffset(Base_TimerOffset timerOffset)

Set the timerOffset attribute value.

Parameters:

timerOffset - the org.jmisb.api.klv.st1904.Base_TimerOffset value to set.

getNumericPrecision

public NumericalPrecision getNumericPrecision()

Get the numericPrecision attribute value.

Returns:

a org.jmisb.api.klv.st1904.NumericalPrecision value, or null if not set.

setNumericPrecision

public void setNumericPrecision(NumericalPrecision numericPrecision)

Set the numericPrecision attribute value.

Parameters:

numericPrecision - the NumericPrecision value to set.

getSecurity

public MimdIdReference getSecurity()

Get the security attribute value.

Returns:

a MimdIdReference value, or null if not set.

setSecurity

public void setSecurity(MimdIdReference security)

Set the security attribute value.

Parameters:

security - the MimdIdReference value to set.

getClassifyingMethod

public Security_ClassifyingMethod getClassifyingMethod()

Get the classifyingMethod attribute value.

Returns:

a org.jmisb.api.klv.st1903.Security_ClassifyingMethod value, or null if not set.

setClassifyingMethod

public void setClassifyingMethod(Security_ClassifyingMethod classifyingMethod)

Set the classifyingMethod attribute value.

Parameters:

classifyingMethod - the org.jmisb.api.klv.st1903.Security_ClassifyingMethod value to set.

getClassification

public Security_Classification getClassification()

Get the classification attribute value.

Returns:

a org.jmisb.api.klv.st1903.Security_Classification value, or null if not set.

setClassification

public void setClassification(Security_Classification classification)

Set the classification attribute value.

Parameters:

classification - the org.jmisb.api.klv.st1903.Security_Classification value to set.

fromBytes

public static Security fromBytes(byte[] bytes)
                          throws KlvParseException

Create Security Local Set from encoded bytes.

Parameters:

bytes - Encoded byte array

Returns:

new Security corresponding to the encoded byte array.

Throws:

KlvParseException - if the array could not be parsed

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

getDisplayName

public String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Specified by:

getDisplayName in interface IKlvValue

Returns:

The name of the type

getDisplayableValue

public String getDisplayableValue()

Description copied from interface: IKlvValue

Return a string of the displayable value.

Specified by:

getDisplayableValue in interface IKlvValue

Returns:

String representing the value

getField

public IKlvValue getField(IKlvKey tag)

Description copied from interface: INestedKlvValue

Get the value of a given item.

Specified by:

getField in interface INestedKlvValue

Parameters:

tag - Tag or other identifier of the value to retrieve

Returns:

The value, or null if no value was set

getIdentifiers

public Set<? extends IKlvKey> getIdentifiers()

Description copied from interface: INestedKlvValue

Get the set of identifiers for populated values.

Specified by:

getIdentifiers in interface INestedKlvValue

Returns:

The set of item identifiers for which values have been set