- java.lang.Object
-
- org.refcodes.serial.AbstractPayloadSegment<Byte>
-
- org.refcodes.serial.ByteSegment
-
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.LengthAccessor
,org.refcodes.mixin.PayloadAccessor<Byte>
,org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Byte,PayloadTransmission<Byte>>
,org.refcodes.mixin.PayloadAccessor.PayloadMutator<Byte>
,org.refcodes.mixin.PayloadAccessor.PayloadProperty<Byte>
,PayloadSegment<Byte>
,PayloadTransmission<Byte>
,Segment
,Segment.SegmentMixin
,Transmission
,Transmission.TransmissionMixin
public class ByteSegment extends AbstractPayloadSegment<Byte> implements Segment
TheByteSegment
is an implementation of aSegment
carrying in byte 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
-
-
Field Summary
Fields Modifier and Type Field Description static int
BYTES
-
Fields inherited from class org.refcodes.serial.AbstractPayloadSegment
_alias, _payload
-
-
Constructor Summary
Constructors Constructor Description ByteSegment()
Constructs an emptyByteSegment
.ByteSegment(Byte aValue)
Constructs aByteSegment
with the given byte payload.ByteSegment(String aAlias)
Constructs an emptyByteSegment
.ByteSegment(String aAlias, Byte aValue)
Constructs aByteSegment
with the given byte payload.
-
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
.ByteSegment
withPayload(Byte 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
-
BYTES
public static final int BYTES
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ByteSegment
public ByteSegment()
Constructs an emptyByteSegment
.
-
ByteSegment
public ByteSegment(Byte aValue)
Constructs aByteSegment
with the given byte payload.- Parameters:
aValue
- The value (payload) to be contained by theSegment
.
-
ByteSegment
public ByteSegment(String aAlias)
Constructs an emptyByteSegment
.- Parameters:
aAlias
- The alias which identifies the content of this segment.
-
ByteSegment
public ByteSegment(String aAlias, Byte aValue)
Constructs aByteSegment
with the given byte payload.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The value (payload) to be contained by theSegment
.
-
-
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 ByteSegment withPayload(Byte aValue)
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<Byte,PayloadTransmission<Byte>>
-
-