- java.lang.Object
-
- org.refcodes.serial.AbstractPayloadSegment<Short>
-
- org.refcodes.serial.ShortSegment
-
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.LengthAccessor
,org.refcodes.mixin.PayloadAccessor<Short>
,org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Short,PayloadTransmission<Short>>
,org.refcodes.mixin.PayloadAccessor.PayloadMutator<Short>
,org.refcodes.mixin.PayloadAccessor.PayloadProperty<Short>
,PayloadSegment<Short>
,PayloadTransmission<Short>
,Segment
,Segment.SegmentMixin
,Transmission
,Transmission.TransmissionMixin
public class ShortSegment extends AbstractPayloadSegment<Short> implements Segment
TheShortSegment
is an implementation of aSegment
carrying in short value 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.Segment
Segment.SegmentMixin
-
Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission
Transmission.TransmissionMixin
-
-
Constructor Summary
Constructors Constructor Description ShortSegment()
Constructs an emptyShortSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.ShortSegment(Short aValue)
Constructs aShortSegment
with the given short payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.ShortSegment(Short aValue, org.refcodes.numerical.Endianess aEndianess)
Constructs aShortSegment
with the given short payload and the givenEndianess
for the representation of theSegment
's value.ShortSegment(Short aValue, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration.ShortSegment(String aAlias)
Constructs an emptyShortSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.ShortSegment(String aAlias, Short aValue)
Constructs aShortSegment
with the given short payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.ShortSegment(String aAlias, Short aValue, org.refcodes.numerical.Endianess aEndianess)
Constructs aShortSegment
with the given short payload and the givenEndianess
for the representation of theSegment
's value.ShortSegment(String aAlias, Short aValue, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration.ShortSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
Constructs an emptyShortSegment
with the givenEndianess
endian representation of theShortSegment
's value.ShortSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration.ShortSegment(org.refcodes.numerical.Endianess aEndianess)
Constructs an emptyShortSegment
with the givenEndianess
endian representation of theShortSegment
's value.ShortSegment(TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration.
-
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.int
getLength()
Determines the overall length of thisTransmission
.Schema
toSchema()
Retrieves theSchema
representing theTransmission
.Sequence
toTransmission()
Provides theSequence
representation of thisTransmission
.ShortSegment
withPayload(Short aValue)
-
Methods inherited from class org.refcodes.serial.AbstractPayloadSegment
equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeMap, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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
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
-
BYTES
public static final int BYTES
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ShortSegment
public ShortSegment(TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
ShortSegment
public ShortSegment(Short aValue, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aValue
- The payload to be contained by theDoubleArraySection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
ShortSegment
public ShortSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
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
- TheTransmissionMetrics
to be used for configuring this instance.
-
ShortSegment
public ShortSegment(String aAlias, Short aValue, TransmissionMetrics aTransmissionMetrics)
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
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.aValue
- The payload to be contained by theDoubleArraySection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
ShortSegment
public ShortSegment()
Constructs an emptyShortSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.
-
ShortSegment
public ShortSegment(org.refcodes.numerical.Endianess aEndianess)
Constructs an emptyShortSegment
with the givenEndianess
endian representation of theShortSegment
's value.- Parameters:
aEndianess
- TheEndianess
to be used for the payload values.
-
ShortSegment
public ShortSegment(Short aValue)
Constructs aShortSegment
with the given short payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.- Parameters:
aValue
- The value (payload) to be contained by theShortSegment
.
-
ShortSegment
public ShortSegment(Short aValue, org.refcodes.numerical.Endianess aEndianess)
Constructs aShortSegment
with the given short payload and the givenEndianess
for the representation of theSegment
's value.- Parameters:
aValue
- The value (payload) to be contained by theShortSegment
.aEndianess
- TheEndianess
to be used for the payload values.
-
ShortSegment
public ShortSegment(String aAlias)
Constructs an emptyShortSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.
-
ShortSegment
public ShortSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
Constructs an emptyShortSegment
with the givenEndianess
endian representation of theShortSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aEndianess
- TheEndianess
to be used for the payload values.
-
ShortSegment
public ShortSegment(String aAlias, Short aValue)
Constructs aShortSegment
with the given short payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theShortSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The value (payload) to be contained by theShortSegment
.
-
ShortSegment
public ShortSegment(String aAlias, Short aValue, org.refcodes.numerical.Endianess aEndianess)
Constructs aShortSegment
with the given short payload and the givenEndianess
for the representation of theSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The value (payload) to be contained by theShortSegment
.aEndianess
- TheEndianess
to be used for the payload values.
-
-
Method Detail
-
toTransmission
public Sequence toTransmission()
Provides theSequence
representation of thisTransmission
. In case of nestedTransmission
instances, allSequence
representations from all sub-segments are accumulated to the result as well.- Specified by:
toTransmission
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.
-
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).
-
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.
-
withPayload
public ShortSegment withPayload(Short aValue)
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<Short,PayloadTransmission<Short>>
-
-