Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractPayloadSection<T>

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<T>

Type Parameters:

T - The type of the body'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>, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, PayloadSection<T>, PayloadTransmission<T>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

BooleanArraySection, ByteArraySection, CharArraySection, CharSection, DoubleArraySection, FileSection, FloatArraySection, IntArraySection, LongArraySection, PropertiesSection, ShortArraySection, StringSection

public abstract class AbstractPayloadSection<T>
extends Object
implements PayloadSection<T>, Section.SectionMixin

An abstract implementation of a Section 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,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P>

Nested classes/interfaces inherited from interface org.refcodes.serial.Section

Section.SectionMixin

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	AbstractPayloadSection()	Empty constructor fur sub-classes.
	AbstractPayloadSection(String aAlias)	Constructs an empty Section to be initialized via Section.fromTransmission(Sequence, int) or Section.fromTransmission(Sequence, int, int).
	AbstractPayloadSection(String aAlias, T aValue)	Constructs a Section 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)
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.Section

fromTransmission, fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Section.SectionMixin

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 Details

_payload

protected T _payload

_alias

protected String _alias

Constructor Details

AbstractPayloadSection

protected AbstractPayloadSection()

Empty constructor fur sub-classes.

AbstractPayloadSection

public AbstractPayloadSection(String aAlias)

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

Parameters:

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

AbstractPayloadSection

public AbstractPayloadSection(String aAlias,
 T aValue)

Constructs a Section 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 Section.

Method Details

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

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 org.refcodes.mixin.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

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.