Module org.refcodes.serial

Package org.refcodes.serial

Class LengthSegmentDecoratorSegment<DECORATEE extends Segment>

java.lang.Object

org.refcodes.serial.AbstractReferenceeLengthSegment<DECORATEE>

org.refcodes.serial.AbstractLengthDecoratorSegment<DECORATEE>

org.refcodes.serial.LengthSegmentDecoratorSegment<DECORATEE>

Type Parameters:

DECORATEE - The type of the Segment 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

public class LengthSegmentDecoratorSegment<DECORATEE extends Segment>
extends AbstractLengthDecoratorSegment<DECORATEE>
implements Segment

An LengthSegmentDecoratorSegment enriches a Segment with an allocation declaration being prefixed to the enriched Segment.

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

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

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.

Methods inherited from class org.refcodes.serial.AbstractLengthDecoratorSegment

getDecoratee, getLength, toSchema, toSequence, toString, transmitTo

Methods inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment

equals, getAllocLength, getEndianess, getLengthWidth, hashCode, 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, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSchema, toSequence, toSimpleTypeMap, transmitTo, transmitTo

Constructor Detail

LengthSegmentDecoratorSegment

public LengthSegmentDecoratorSegment(DECORATEE aDecoratee,
                                     TransmissionMetrics aTransmissionMetrics)

LengthSegmentDecoratorSegment

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

LengthSegmentDecoratorSegment

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

LengthSegmentDecoratorSegment

public LengthSegmentDecoratorSegment(DECORATEE aDecoratee,
                                     int aLengthWidth)

LengthSegmentDecoratorSegment

public LengthSegmentDecoratorSegment(DECORATEE aDecoratee)

Method Detail

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

Overrides:

fromTransmission in class AbstractReferenceeLengthSegment<DECORATEE extends 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.

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        OutputStream aReturnStream)
                 throws IOException,
                        TransmissionException

(Re-)initializes this instance by receiving the according Sequence from the given InputStream. Implementations providing error correction methods use the provided feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.

Specified by:

receiveFrom in interface Segment

Overrides:

receiveFrom in class AbstractReferenceeLengthSegment<DECORATEE extends Segment>

Parameters:

aInputStream - The InputStream from which to read the instance's (re-)initialization Sequence from.

aReturnStream - An OutputStream 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 reading data from the InputStream caused problems.

TransmissionException - thrown in case a given transmission cannot be processed.