Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractLengthDecoratorSegment<DECORATEE extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractReferenceeLengthSegment<DECORATEE>

org.refcodes.serial.AbstractLengthDecoratorSegment<DECORATEE>

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.numerical.EndianessAccessor, AllocLengthAccessor, DecoratorSegment<DECORATEE>, LengthWidthAccessor, Segment, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

AllocSectionDecoratorSegment, LengthSegmentDecoratorSegment

public abstract class AbstractLengthDecoratorSegment<DECORATEE extends Transmission>
extends AbstractReferenceeLengthSegment<DECORATEE>
implements DecoratorSegment<DECORATEE>

The AbstractLengthDecoratorSegment decorates a decoratee with a length prefix.

See Also:

Serialized Form

Nested Class Summary

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

AllocLengthAccessor.AllocLengthBuilder<B extends AllocLengthAccessor.AllocLengthBuilder<B>>, AllocLengthAccessor.AllocLengthMutator, AllocLengthAccessor.AllocLengthProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DecorateeAccessor

org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE extends Object,B extends org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE,B>>, org.refcodes.mixin.DecorateeAccessor.DecorateeMutator<DECORATEE extends Object>, org.refcodes.mixin.DecorateeAccessor.DecorateeProperty<DECORATEE extends Object>

Nested classes/interfaces inherited from interface org.refcodes.numerical.EndianessAccessor

org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B extends org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B>>, org.refcodes.numerical.EndianessAccessor.EndianessMutator, org.refcodes.numerical.EndianessAccessor.EndianessProperty

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.serial.LengthWidthAccessor

LengthWidthAccessor.LengthWidthBuilder<B extends LengthWidthAccessor.LengthWidthBuilder<B>>, LengthWidthAccessor.LengthWidthMutator, LengthWidthAccessor.LengthWidthProperty

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 inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment

_allocLength, _endianess, _lengthWidth, _referencee, LENGTH_ENDIANESS, LENGTH_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLengthDecoratorSegment()
protected	AbstractLengthDecoratorSegment(int aLengthWidth)
protected	AbstractLengthDecoratorSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
	AbstractLengthDecoratorSegment(DECORATEE aDecoratee)
	AbstractLengthDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth)
	AbstractLengthDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
	AbstractLengthDecoratorSegment(DECORATEE aDecoratee, org.refcodes.numerical.Endianess aEndianess)
	AbstractLengthDecoratorSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
protected	AbstractLengthDecoratorSegment(org.refcodes.numerical.Endianess aEndianess)
protected	AbstractLengthDecoratorSegment(TransmissionMetrics aTransmissionMetrics)

Method Summary

Modifier and Type	Method	Description
DECORATEE	getDecoratee()
int	getLength()	Determines the overall length of this Transmission.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
String	toString()
Sequence	toTransmission()	Provides the Sequence representation of this Transmission.
void	transmitTo(OutputStream aOutputStream, InputStream aReturnStream)	Transmits the Sequence representing the implementing type's instance to the given OutputStream.

Methods inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment

equals, fromTransmission, getAllocLength, getEndianess, getLengthWidth, hashCode, receiveFrom, toSimpleTypeMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

toSimpleTypeMap, transmitTo, transmitTo

Constructor Detail

AbstractLengthDecoratorSegment

protected AbstractLengthDecoratorSegment(TransmissionMetrics aTransmissionMetrics)

AbstractLengthDecoratorSegment

public AbstractLengthDecoratorSegment(DECORATEE aDecoratee,
                                      TransmissionMetrics aTransmissionMetrics)

AbstractLengthDecoratorSegment

protected AbstractLengthDecoratorSegment()

AbstractLengthDecoratorSegment

protected AbstractLengthDecoratorSegment(org.refcodes.numerical.Endianess aEndianess)

AbstractLengthDecoratorSegment

protected AbstractLengthDecoratorSegment(int aLengthWidth)

AbstractLengthDecoratorSegment

protected AbstractLengthDecoratorSegment(int aLengthWidth,
                                         org.refcodes.numerical.Endianess aEndianess)

AbstractLengthDecoratorSegment

public AbstractLengthDecoratorSegment(DECORATEE aDecoratee)

AbstractLengthDecoratorSegment

public AbstractLengthDecoratorSegment(DECORATEE aDecoratee,
                                      org.refcodes.numerical.Endianess aEndianess)

AbstractLengthDecoratorSegment

public AbstractLengthDecoratorSegment(DECORATEE aDecoratee,
                                      int aLengthWidth)

AbstractLengthDecoratorSegment

public AbstractLengthDecoratorSegment(DECORATEE aDecoratee,
                                      int aLengthWidth,
                                      org.refcodes.numerical.Endianess aEndianess)

Method Detail

toTransmission

public Sequence toTransmission()

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.

Specified by:

toTransmission in interface Transmission

Overrides:

toTransmission in class AbstractReferenceeLengthSegment<DECORATEE extends Transmission>

Returns:

The according instance's Sequence.

transmitTo

public void transmitTo(OutputStream aOutputStream,
                       InputStream aReturnStream)
                throws IOException

Transmits the Sequence representing the implementing type's instance to the given OutputStream. Implementations providing error correction methods use the provided feedback InputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the transmitted data.

Specified by:

transmitTo in interface Transmission

Specified by:

transmitTo in interface Transmission.TransmissionMixin

Parameters:

aOutputStream - The OutputStream where to write this instance's Sequence to.

aReturnStream - An InputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.

Throws:

IOException - thrown in case writing data to the OutputStream caused problems.

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

Overrides:

getLength in class AbstractReferenceeLengthSegment<DECORATEE extends Transmission>

Returns:

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

getDecoratee

public DECORATEE getDecoratee()

Specified by:

getDecoratee in interface org.refcodes.mixin.DecorateeAccessor<DECORATEE extends Transmission>

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

Overrides:

toSchema in class AbstractReferenceeLengthSegment<DECORATEE extends Transmission>

Returns:

The Schema representation of the implementing type for debugging and verification (or documentation) purposes.

toString

public String toString()

Overrides:

toString in class AbstractReferenceeLengthSegment<DECORATEE extends Transmission>