Module org.refcodes.serial

Package org.refcodes.serial

Class LongArraySection

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<long[]>

org.refcodes.serial.LongArraySection

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<long[]>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<long[],PayloadTransmission<long[]>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<long[]>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<long[]>, PayloadSection<long[]>, PayloadTransmission<long[]>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class LongArraySection
extends AbstractPayloadSection<long[]>
implements PayloadSection<long[]>

The LongArraySection is an implementation of a Section carrying a long array as payload.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor

org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PayloadAccessor

org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P extends Object,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P extends Object>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P extends Object>

Nested classes/interfaces inherited from interface org.refcodes.serial.Section

Section.SectionMixin

Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDIANESS

Fields inherited from class org.refcodes.serial.AbstractPayloadSection

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
LongArraySection()	Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(long... aValue)	Constructs a LongArraySection with the given long array payload and the given a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(Long... aValue)	Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(String aAlias)	Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(String aAlias, long... aValue)	Constructs a LongArraySection with the given long array payload and the given a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(String aAlias, Long... aValue)	Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
LongArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)	Constructs an empty LongArraySection with the given Endianess.
LongArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, long... aValue)	Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
LongArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Long... aValue)	Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
LongArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
LongArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, long... aValue)	Constructs an according instance from the given configuration.
LongArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Long... aValue)	Constructs an according instance from the given configuration.
LongArraySection(org.refcodes.numerical.Endianess aEndianess)	Constructs an empty LongArraySection with the given Endianess.
LongArraySection(org.refcodes.numerical.Endianess aEndianess, long... aValue)	Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
LongArraySection(org.refcodes.numerical.Endianess aEndianess, Long... aValue)	Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
LongArraySection(TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
LongArraySection(TransmissionMetrics aTransmissionMetrics, long... aValue)	Constructs an according instance from the given configuration.
LongArraySection(TransmissionMetrics aTransmissionMetrics, Long... aValue)	Constructs an according instance from the given configuration.

Method Summary

Modifier and Type	Method	Description
void	fromTransmission(Sequence aSequence, int aOffset, int aLength)	(Re-)initializes this instance with the the given Sequence data.
int	getLength()	Determines the overall length of this Transmission.
void	setPayload(Long[] aPayload)	Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking AbstractPayloadSection.setPayload(Object).
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
String	toString()
LongArraySection	withPayload(long[] aValue)
LongArraySection	withPayload(Long[] aPayload)	Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking withPayload(long[]).

Methods inherited from class org.refcodes.serial.AbstractPayloadSection

equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.PayloadAccessor

getPayload, getPayloadOr

Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadMutator

setPayload

Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface org.refcodes.serial.Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Section.SectionMixin

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

toSimpleTypeMap, transmitTo, transmitTo

Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin

transmitTo

Field Detail

ENDIANESS

public static final String ENDIANESS

See Also:

Constant Field Values

Constructor Detail

LongArraySection

public LongArraySection(TransmissionMetrics aTransmissionMetrics)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

LongArraySection

public LongArraySection(TransmissionMetrics aTransmissionMetrics,
                        long... aValue)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(TransmissionMetrics aTransmissionMetrics,
                        Long... aValue)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias,
                        TransmissionMetrics aTransmissionMetrics)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this instance.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

LongArraySection

public LongArraySection(String aAlias,
                        TransmissionMetrics aTransmissionMetrics,
                        long... aValue)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this instance.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias,
                        TransmissionMetrics aTransmissionMetrics,
                        Long... aValue)

Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this instance.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection()

Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

LongArraySection

public LongArraySection(org.refcodes.numerical.Endianess aEndianess)

Constructs an empty LongArraySection with the given Endianess.

Parameters:

aEndianess - The Endianess to be used for payload values.

LongArraySection

public LongArraySection(long... aValue)

Constructs a LongArraySection with the given long array payload and the given a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

Parameters:

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(Long... aValue)

Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

Parameters:

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(org.refcodes.numerical.Endianess aEndianess,
                        long... aValue)

Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.

Parameters:

aEndianess - The Endianess to be used for payload values.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(org.refcodes.numerical.Endianess aEndianess,
                        Long... aValue)

Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.

Parameters:

aEndianess - The Endianess to be used for payload values.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias)

Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

Parameters:

aAlias - The alias which identifies the content of this segment.

LongArraySection

public LongArraySection(String aAlias,
                        org.refcodes.numerical.Endianess aEndianess)

Constructs an empty LongArraySection with the given Endianess.

Parameters:

aAlias - The alias which identifies the content of this segment.

aEndianess - The Endianess to be used for payload values.

LongArraySection

public LongArraySection(String aAlias,
                        long... aValue)

Constructs a LongArraySection with the given long array payload and the given a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

Parameters:

aAlias - The alias which identifies the content of this segment.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias,
                        Long... aValue)

Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.

Parameters:

aAlias - The alias which identifies the content of this segment.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias,
                        org.refcodes.numerical.Endianess aEndianess,
                        long... aValue)

Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.

Parameters:

aAlias - The alias which identifies the content of this segment.

aEndianess - The Endianess to be used for payload values.

aValue - The payload to be contained by the LongArraySection.

LongArraySection

public LongArraySection(String aAlias,
                        org.refcodes.numerical.Endianess aEndianess,
                        Long... aValue)

Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.

Parameters:

aAlias - The alias which identifies the content of this segment.

aEndianess - The Endianess to be used for payload values.

aValue - The payload to be contained by the LongArraySection.

Method Detail

toSequence

public Sequence toSequence()

Provides the Sequence representation of this Transmission. In case of nested Transmission instances, all Sequence representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.

Specified by:

toSequence in interface Transmission

Returns:

The according instance's Sequence.

fromTransmission

public void fromTransmission(Sequence aSequence,
                             int aOffset,
                             int aLength)
                      throws TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Section

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

aLength - The length of data assigned by the Sequence.

Throws:

TransmissionException - thrown in case a given Sequence cannot be processed.

getLength

public int getLength()

Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

Specified by:

getLength in interface Transmission

Returns:

The (overall) length of the Transmission (including any sub-segments).

toSchema

public Schema toSchema()

Retrieves the Schema representing the Transmission. Retrieving a Schema is useful when analyzing and debugging data structures such as a AllocSectionDecoratorSegment instance to help document, learn and verify on the structure (as well as the content) of that very AllocSectionDecoratorSegment.

Specified by:

toSchema in interface Transmission

Returns:

The Schema representation of the implementing type for debugging and verification (or documentation) purposes.

toString

public String toString()

Overrides:

toString in class AbstractPayloadSection<long[]>

withPayload

public LongArraySection withPayload(long[] aValue)

Specified by:

withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<long[],PayloadTransmission<long[]>>

setPayload

public void setPayload(Long[] aPayload)

Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking AbstractPayloadSection.setPayload(Object).

Parameters:

aPayload - The payload with the wrapper types.

withPayload

public LongArraySection withPayload(Long[] aPayload)

Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking withPayload(long[]).

Parameters:

aPayload - The payload with the wrapper types.

Returns:

This instance as of the builder pattern.