Class SequenceSection

java.lang.Object

org.refcodes.serial.SequenceSection

All Implemented Interfaces:

Serializable, AliasAccessor, LengthAccessor, PayloadAccessor<Sequence>, PayloadAccessor.PayloadBuilder<Sequence, PayloadTransmission<Sequence>>, PayloadAccessor.PayloadMutator<Sequence>, PayloadAccessor.PayloadProperty<Sequence>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, PayloadSection<Sequence>, PayloadTransmission<Sequence>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

DynamicTypeSection

public class SequenceSection
extends Object
implements PayloadSection<Sequence>, Section.SectionMixin

The SequenceSection is a Section representing a Sequence.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface LengthAccessor

LengthAccessor.LengthBuilder<B>, LengthAccessor.LengthMutator, LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface PayloadAccessor

PayloadAccessor.PayloadBuilder<P,B>, PayloadAccessor.PayloadMutator<P>, PayloadAccessor.PayloadProperty<P>

Nested classes/interfaces inherited from interface Section

Section.SectionMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alias
protected Sequence	_sequence

Constructor Summary

Constructors

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

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.
String	getAlias()
int	getLength()	Determines the overall length of this Transmission.
Sequence	getPayload()
void	reset()	Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!)
void	setPayload(Sequence aValue)
Schema	toSchema()
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
SimpleTypeTable	toSimpleTypeTable()	Returns the ImmutableSimpleTypeTable representation of this Transmission.
PayloadTransmission<Sequence>	withPayload(Sequence aValue)

Methods inherited from class Object

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

Methods inherited from interface PayloadAccessor

getPayloadOr

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface Schemable

toSchema

Methods inherited from interface Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Section.SectionMixin

receiveFrom

Methods inherited from interface Transmission

transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Field Details

_sequence

protected Sequence _sequence

_alias

protected String _alias

Constructor Details

SequenceSection

public SequenceSection()

Constructs the SequenceSection.

SequenceSection

public SequenceSection(String aAlias)

Constructs the SequenceSection.

Parameters:

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

SequenceSection

public SequenceSection(int aSequenceSize)

Constructs the SequenceSection.

Parameters:

aSequenceSize - The size of the Sequence.

SequenceSection

public SequenceSection(String aAlias,
 int aSequenceSize)

Constructs the SequenceSection.

Parameters:

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

aSequenceSize - The size of the Sequence.

SequenceSection

public SequenceSection(Sequence aSequence)

Constructs the SequenceSection.

Parameters:

aSequence - The Sequence representing this SequenceSection.

SequenceSection

public SequenceSection(String aAlias,
 Sequence aSequence)

Constructs the SequenceSection.

Parameters:

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

aSequence - The Sequence representing this SequenceSection.

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

reset

public void reset()

Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!) reset any configurations or settings required to produce the dynamic data (e.g. the TransmissionMetrics).

Specified by:

reset in interface Resetable

Specified by:

reset in interface Transmission

toSchema

public Schema toSchema()

Specified by:

toSchema in interface Schemable<DiagnosticOptions>

getAlias

public String getAlias()

Specified by:

getAlias in interface AliasAccessor

withPayload

public PayloadTransmission<Sequence> withPayload(Sequence aValue)

Specified by:

withPayload in interface PayloadAccessor.PayloadBuilder<Sequence, PayloadTransmission<Sequence>>

getPayload

public Sequence getPayload()

Specified by:

getPayload in interface PayloadAccessor<Sequence>

setPayload

public void setPayload(Sequence aValue)

Specified by:

setPayload in interface PayloadAccessor.PayloadMutator<Sequence>

toSimpleTypeTable

public SimpleTypeTable toSimpleTypeTable()

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

Specified by:

toSimpleTypeTable in interface Transmission

Returns:

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