Module org.refcodes.serial

Package org.refcodes.serial

Class ByteSegment

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

The ByteSegment is an implementation of a Segment 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 empty ByteSegment.
ByteSegment(Byte aValue)	Constructs a ByteSegment with the given byte payload.
ByteSegment(String aAlias)	Constructs an empty ByteSegment.
ByteSegment(String aAlias, Byte aValue)	Constructs a ByteSegment with the given byte payload.

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
int	getLength()	Determines the overall length of this Transmission.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
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.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

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

ByteSegment

public ByteSegment(Byte aValue)

Constructs a ByteSegment with the given byte payload.

Parameters:

aValue - The value (payload) to be contained by the Segment.

ByteSegment

public ByteSegment(String aAlias)

Constructs an empty ByteSegment.

Parameters:

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

ByteSegment

public ByteSegment(String aAlias,
                   Byte aValue)

Constructs a ByteSegment with the given byte payload.

Parameters:

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

aValue - The value (payload) to be contained by the Segment.

Method Detail

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.

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

toSchema

public Schema toSchema()

Retrieves the Schema representing the Transmission. Retrieving a Schema 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 Transmission

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 interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Byte,PayloadTransmission<Byte>>