- 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>
,PayloadSegment<Sequence>
,PayloadTransmission<Sequence>
,Segment
,Segment.SegmentMixin
,Transmission
,Transmission.TransmissionMixin
public class FixedLengthSequenceSegment extends Object implements PayloadSegment<Sequence>, Segment.SegmentMixin
TheFixedLengthSequenceSegment
is aSegment
representing aSequence
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
-
-
Constructor Summary
Constructors Constructor Description FixedLengthSequenceSegment(int aSequenceSize)
Constructs theFixedLengthSequenceSegment
.FixedLengthSequenceSegment(String aAlias, int aSequenceSize)
Constructs theFixedLengthSequenceSegment
.FixedLengthSequenceSegment(String aAlias, Sequence aSequence)
Constructs theFixedLengthSequenceSegment
.FixedLengthSequenceSegment(Sequence aSequence)
Constructs theFixedLengthSequenceSegment
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
fromTransmission(Sequence aSequence, int aOffset)
(Re-)initializes this instance with the the givenSequence
data.String
getAlias()
int
getLength()
Determines the overall length of thisTransmission
.Sequence
getPayload()
void
setPayload(Sequence aValue)
Schema
toSchema()
Retrieves theSchema
representing theTransmission
.Sequence
toSequence()
Provides theSequence
representation of thisTransmission
.org.refcodes.struct.SimpleTypeMap
toSimpleTypeMap()
Returns theSimpleTypeMap
representation of thisTransmission
.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.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
-
-
-
-
Constructor Detail
-
FixedLengthSequenceSegment
public FixedLengthSequenceSegment(int aSequenceSize)
Constructs theFixedLengthSequenceSegment
.- Parameters:
aSequenceSize
- The size of theSequence
.
-
FixedLengthSequenceSegment
public FixedLengthSequenceSegment(String aAlias, int aSequenceSize)
Constructs theFixedLengthSequenceSegment
.
-
FixedLengthSequenceSegment
public FixedLengthSequenceSegment(Sequence aSequence)
Constructs theFixedLengthSequenceSegment
.- Parameters:
aSequence
- TheSequence
representing thisFixedLengthSequenceSegment
.
-
FixedLengthSequenceSegment
public FixedLengthSequenceSegment(String aAlias, Sequence aSequence)
Constructs theFixedLengthSequenceSegment
.- Parameters:
aAlias
- The alias which identifies the content of thisSegment
.aSequence
- TheSequence
representing thisFixedLengthSequenceSegment
.
-
-
Method Detail
-
getLength
public int getLength()
Determines the overall length of thisTransmission
. In case of nestedTransmission
instances, all length values from all sub-segments are accumulated to the result as well.- Specified by:
getLength
in interfaceorg.refcodes.mixin.LengthAccessor
- Specified by:
getLength
in interfaceTransmission
- Returns:
- The (overall) length of the
Transmission
(including any sub-segments).
-
toSequence
public Sequence toSequence()
Provides theSequence
representation of thisTransmission
. In case of nestedTransmission
instances, allSequence
representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nestedTransmission
instances) may be backed by the returnedSequence
.- Specified by:
toSequence
in interfaceTransmission
- Returns:
- The according instance's
Sequence
.
-
fromTransmission
public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
(Re-)initializes this instance with the the givenSequence
data.- Specified by:
fromTransmission
in interfaceSegment
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.- Returns:
- The index after the last offset into the given
Sequence
processed by this method. - Throws:
TransmissionException
- thrown in case a givenSequence
cannot be processed.
-
toSchema
public Schema toSchema()
Retrieves theSchema
representing theTransmission
. Retrieving aSchema
is useful when analyzing and debugging data structures such as aAllocSectionDecoratorSegment
instance to help document, learn and verify on the structure (as well as the content) of that veryAllocSectionDecoratorSegment
.- Specified by:
toSchema
in interfaceTransmission
- Returns:
- The
Schema
representation of the implementing type for debugging and verification (or documentation) purposes.
-
getAlias
public String getAlias()
- Specified by:
getAlias
in interfaceorg.refcodes.mixin.AliasAccessor
-
withPayload
public PayloadTransmission<Sequence> withPayload(Sequence aValue)
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<Sequence,PayloadTransmission<Sequence>>
-
getPayload
public Sequence getPayload()
- Specified by:
getPayload
in interfaceorg.refcodes.mixin.PayloadAccessor<Sequence>
-
setPayload
public void setPayload(Sequence aValue)
- Specified by:
setPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadMutator<Sequence>
-
toSimpleTypeMap
public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()
Returns theSimpleTypeMap
representation of thisTransmission
. In case this Transmission hasTransmission
children, then the children are queried as well and contained in the resultingSimpleTypeMap
. The aliases of the accordingTransmission
instances represent the resulting path to aTransmission
's final simple type.- Specified by:
toSimpleTypeMap
in interfaceTransmission
- Returns:
- The
SimpleTypeMap
representing thisTransmission
and (if any) its children, with the according aliases forming the paths to theTransmission
's values.
-
-