Class AbstractPayloadSegment<T>

java.lang.Object

org.refcodes.serial.AbstractPayloadSegment<T>

Type Parameters:

T - The type of the segment's payload.

All Implemented Interfaces:

Serializable, AliasAccessor, LengthAccessor, PayloadAccessor<T>, PayloadAccessor.PayloadBuilder<T, PayloadTransmission<T>>, PayloadAccessor.PayloadMutator<T>, PayloadAccessor.PayloadProperty<T>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, PayloadSegment<T>, PayloadTransmission<T>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

AsciizArraySegment, AsciizSegment, BooleanSegment, ByteSegment, DoubleSegment, EnumSegment, FloatSegment, IntSegment, LongSegment, NumberSegment, ShortSegment

public abstract class AbstractPayloadSegment<T>
extends Object
implements PayloadSegment<T>, Segment.SegmentMixin

An abstract implementation of a Segment with 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
protected String	_alias
protected T	_payload

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPayloadSegment()	Empty constructor fur sub-classes.
	AbstractPayloadSegment(String aAlias)	Constructs an empty Segment to be initialized via Segment.fromTransmission(Sequence) or Segment.fromTransmission(Sequence, int).
	AbstractPayloadSegment(String aAlias, T aValue)	Constructs a Segment instance with the given value.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAlias()
T	getPayload()
int	hashCode()
void	reset()	Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!)
void	setPayload(T aValue)
SimpleTypeTable	toSimpleTypeTable()	Returns the ImmutableSimpleTypeTable representation of this Transmission.
String	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.PayloadBuilder

withPayload

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface Schemable

toSchema, toSchema

Methods inherited from interface Segment

fromTransmission, fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Segment.SegmentMixin

receiveFrom

Methods inherited from interface Transmission

getLength, toSequence, transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Field Details

_payload

protected T _payload

_alias

protected String _alias

Constructor Details

AbstractPayloadSegment

protected AbstractPayloadSegment()

Empty constructor fur sub-classes.

AbstractPayloadSegment

public AbstractPayloadSegment(String aAlias)

Constructs an empty Segment to be initialized via Segment.fromTransmission(Sequence) or Segment.fromTransmission(Sequence, int).

Parameters:

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

AbstractPayloadSegment

public AbstractPayloadSegment(String aAlias,
 T aValue)

Constructs a Segment instance with the given value.

Parameters:

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

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

Method Details

setPayload

public void setPayload(T aValue)

Specified by:

setPayload in interface PayloadAccessor.PayloadMutator<T>

getPayload

public T getPayload()

Specified by:

getPayload in interface PayloadAccessor<T>

getAlias

public String getAlias()

Specified by:

getAlias in interface AliasAccessor

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

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toSimpleTypeTable

public SimpleTypeTable toSimpleTypeTable()

Returns the ImmutableSimpleTypeTable representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting ImmutableSimpleTypeTable. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeTable in interface Transmission

Returns:

The ImmutableSimpleTypeTable representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.