Module org.refcodes.serial

Package org.refcodes.serial

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, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<T>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<T,PayloadTransmission<T>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<T>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<T>, 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 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
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	setPayload(T aValue)
org.refcodes.struct.SimpleTypeMap	toSimpleTypeMap()	Returns the SimpleTypeMap representation of this Transmission.
String	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.PayloadBuilder

withPayload

Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Segment.SegmentMixin

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSchema, toSequence, transmitTo, transmitTo

Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin

transmitTo

Field Detail

_payload

protected T _payload

_alias

protected String _alias

Constructor Detail

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 Detail

setPayload

public void setPayload(T aValue)

Specified by:

setPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadMutator<T>

getPayload

public T getPayload()

Specified by:

getPayload in interface org.refcodes.mixin.PayloadAccessor<T>

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

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

toSimpleTypeMap

public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()

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

Specified by:

toSimpleTypeMap in interface Transmission

Returns:

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