Class ByteSegment

java.lang.Object

org.refcodes.serial.AbstractPayloadSegment<Byte>

org.refcodes.serial.ByteSegment

All Implemented Interfaces:

Serializable, AliasAccessor, LengthAccessor, PayloadAccessor<Byte>, PayloadAccessor.PayloadBuilder<Byte, PayloadTransmission<Byte>>, PayloadAccessor.PayloadMutator<Byte>, PayloadAccessor.PayloadProperty<Byte>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, 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 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 Segment

Segment.SegmentMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BYTES

Fields inherited from class 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)	Instantiates the class ByteSegment.

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.
void	reset()	Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!)
Schema	toSchema()
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
ByteSegment	withPayload(Byte aValue)

Methods inherited from class AbstractPayloadSegment

equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeTable, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, 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 Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Segment.SegmentMixin

receiveFrom

Methods inherited from interface Transmission

toSimpleTypeTable, transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Field Details

BYTES

public static final int BYTES

See Also:

• Constant Field Values

Constructor Details

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)

Instantiates the class ByteSegment.

Parameters:

aAlias - the alias

aValue - the value

See Also:

• AbstractPayloadSegment(String, Object)

Method Details

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 LengthAccessor

Specified by:

getLength in interface Transmission

Returns:

The (overall) length of the Transmission (including any sub-segments).

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

Overrides:

reset in class AbstractPayloadSegment<Byte>

toSchema

public Schema toSchema()

Specified by:

toSchema in interface Schemable<DiagnosticOptions>

withPayload

public ByteSegment withPayload(Byte aValue)

Specified by:

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