Module org.refcodes.serial

Package org.refcodes.serial

Class FixedLengthSequenceSegment

java.lang.Object

org.refcodes.serial.FixedLengthSequenceSegment

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<Sequence>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Sequence,PayloadTransmission<Sequence>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<Sequence>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<Sequence>, org.refcodes.mixin.Schemable<SerialSchema>, PayloadSegment<Sequence>, PayloadTransmission<Sequence>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin

public class FixedLengthSequenceSegment
extends Object
implements PayloadSegment<Sequence>, Segment.SegmentMixin

The FixedLengthSequenceSegment is a Segment representing a Sequence of a fixed length (as of the arguments passed to one of its constructors).

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.Segment

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alias
protected Sequence	_sequence

Constructor Summary

Constructors

Constructor	Description
FixedLengthSequenceSegment(int aSequenceSize)	Constructs the FixedLengthSequenceSegment.
FixedLengthSequenceSegment(String aAlias, int aSequenceSize)	Constructs the FixedLengthSequenceSegment.
FixedLengthSequenceSegment(String aAlias, Sequence aSequence)	Constructs the FixedLengthSequenceSegment.
FixedLengthSequenceSegment(Sequence aSequence)	Constructs the FixedLengthSequenceSegment.

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
String	getAlias()
int	getLength()	Determines the overall length of this Transmission.
Sequence	getPayload()
void	setPayload(Sequence aValue)
SerialSchema	toSchema()	Retrieves the SerialSchema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
org.refcodes.struct.SimpleTypeMap	toSimpleTypeMap()	Returns the SimpleTypeMap representation of this Transmission.
PayloadTransmission<Sequence>	withPayload(Sequence aValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.PayloadAccessor

getPayloadOr

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

letPayload

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Segment.SegmentMixin

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

transmitTo, transmitTo

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

transmitTo

Field Details

_sequence

protected Sequence _sequence

_alias

protected String _alias

Constructor Details

FixedLengthSequenceSegment

public FixedLengthSequenceSegment(int aSequenceSize)

Constructs the FixedLengthSequenceSegment.

Parameters:

aSequenceSize - The size of the Sequence.

FixedLengthSequenceSegment

public FixedLengthSequenceSegment(String aAlias,
 int aSequenceSize)

Constructs the FixedLengthSequenceSegment.

Parameters:

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

aSequenceSize - The size of the Sequence.

FixedLengthSequenceSegment

public FixedLengthSequenceSegment(Sequence aSequence)

Constructs the FixedLengthSequenceSegment.

Parameters:

aSequence - The Sequence representing this FixedLengthSequenceSegment.

FixedLengthSequenceSegment

public FixedLengthSequenceSegment(String aAlias,
 Sequence aSequence)

Constructs the FixedLengthSequenceSegment.

Parameters:

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

aSequence - The Sequence representing this FixedLengthSequenceSegment.

Method Details

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).

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 int fromTransmission(Sequence aSequence,
 int aOffset)
                     throws TransmissionException

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

Specified by:

fromTransmission in interface Segment

Parameters:

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

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

Returns:

The index after the last offset into the given Sequence processed by this method.

Throws:

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

toSchema

public SerialSchema toSchema()

Retrieves the SerialSchema representing the Transmission. Retrieving a SerialSchema 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 org.refcodes.mixin.Schemable<SerialSchema>

Specified by:

toSchema in interface Transmission

Returns:

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

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

withPayload

public PayloadTransmission<Sequence> withPayload(Sequence aValue)

Specified by:

withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Sequence,PayloadTransmission<Sequence>>

getPayload

public Sequence getPayload()

Specified by:

getPayload in interface org.refcodes.mixin.PayloadAccessor<Sequence>

setPayload

public void setPayload(Sequence aValue)

Specified by:

setPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadMutator<Sequence>

toSimpleTypeMap

public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()

Returns the SimpleTypeMap representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting SimpleTypeMap. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeMap in interface Transmission

Returns:

The SimpleTypeMap representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.