org.jmisb.api.klv.st1904

Class RefinedSource_Path

java.lang.Object

org.jmisb.api.klv.st1904.RefinedSource_Path

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IMimdMetadataValue

public class RefinedSource_Path
extends Object
implements IMimdMetadataValue, INestedKlvValue

MIMD RefinedSource path attribute.

This is a specialisation of an unsigned integer 1D array.

See ST1904 for more information on this data type.

Constructor Summary

Constructors

Constructor and Description
RefinedSource_Path(byte[] bytes) Create RefinedSource_Path from encoded bytes.
RefinedSource_Path(long[] value) Construct from value.

Method Summary

Modifier and Type	Method and Description
static RefinedSource_Path	fromBytes(byte[] bytes) Create RefinedSource_Path from encoded bytes.
byte[]	getBytes() Get the encoded bytes.
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.
long[]	getValue() Get the value of this RefinedSource_Path.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefinedSource_Path

public RefinedSource_Path(long[] value)
                   throws KlvParseException

Construct from value. The minimum value for each element in the array is 1.

Parameters:

value - an unsigned integer array to initialise this RefinedSource_Path with.

Throws:

KlvParseException - if the value is not valid.

RefinedSource_Path

public RefinedSource_Path(byte[] bytes)
                   throws KlvParseException

Create RefinedSource_Path from encoded bytes.

Parameters:

bytes - Encoded byte array.

Throws:

KlvParseException - if the array could not be parsed

Method Detail

fromBytes

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

Create RefinedSource_Path from encoded bytes.

Parameters:

bytes - Encoded byte array.

Returns:

new RefinedSource_Path corresponding to the encoded byte array.

Throws:

KlvParseException - if the byte array could not be parsed.

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

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

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

getValue

public long[] getValue()

Get the value of this RefinedSource_Path.

Returns:

the value as an unsigned integer 1D array.

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