Module org.refcodes.serial

Package org.refcodes.serial

Class LengthSegment<REFERENCEE extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractReferenceeLengthSegment<REFERENCEE>

org.refcodes.serial.LengthSegment<REFERENCEE>

Type Parameters:

REFERENCEE - The type of the Transmission referencee.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.ReferenceeAccessor<REFERENCEE>, org.refcodes.mixin.ReferenceeAccessor.ReferenceeMutator<REFERENCEE>, org.refcodes.mixin.ReferenceeAccessor.ReferenceeProperty<REFERENCEE>, org.refcodes.numerical.EndianessAccessor, AllocLengthAccessor, LengthWidthAccessor, Segment, Transmission, Transmission.TransmissionMixin

public class LengthSegment<REFERENCEE extends Transmission>
extends AbstractReferenceeLengthSegment<REFERENCEE>
implements Segment, org.refcodes.mixin.ReferenceeAccessor.ReferenceeProperty<REFERENCEE>

An LengthSegment enriches a Segment with an allocation declaration computed from the referenced Transmission.

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.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.mixin.ReferenceeAccessor

org.refcodes.mixin.ReferenceeAccessor.ReferenceeBuilder<REFERENCEE extends Object,B extends org.refcodes.mixin.ReferenceeAccessor.ReferenceeBuilder<REFERENCEE,B>>, org.refcodes.mixin.ReferenceeAccessor.ReferenceeMutator<REFERENCEE extends Object>, org.refcodes.mixin.ReferenceeAccessor.ReferenceeProperty<REFERENCEE 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 inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment

_allocLength, _endianess, _lengthWidth, _referencee, LENGTH_ENDIANESS, LENGTH_WIDTH

Constructor Summary

Constructors

Constructor	Description
LengthSegment()
LengthSegment(int aLengthWidth)
LengthSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
LengthSegment(org.refcodes.numerical.Endianess aEndianess)
LengthSegment(TransmissionMetrics aTransmissionMetrics)
LengthSegment(REFERENCEE aReferencee)
LengthSegment(REFERENCEE aReferencee, int aLengthWidth)
LengthSegment(REFERENCEE aReferencee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
LengthSegment(REFERENCEE aReferencee, org.refcodes.numerical.Endianess aEndianess)
LengthSegment(REFERENCEE aReferencee, 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.
REFERENCEE	getReferencee()
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
void	setReferencee(REFERENCEE aDecoratee)

Methods inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment

equals, getAllocLength, getEndianess, getLength, getLengthWidth, hashCode, toSchema, toSimpleTypeMap, toString, toTransmission

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.ReferenceeAccessor.ReferenceeProperty

letReferencee

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSchema, toSimpleTypeMap, toTransmission, transmitTo, transmitTo

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

transmitTo

Constructor Detail

LengthSegment

public LengthSegment(TransmissionMetrics aTransmissionMetrics)

LengthSegment

public LengthSegment()

LengthSegment

public LengthSegment(org.refcodes.numerical.Endianess aEndianess)

LengthSegment

public LengthSegment(int aLengthWidth,
                     org.refcodes.numerical.Endianess aEndianess)

LengthSegment

public LengthSegment(int aLengthWidth)

LengthSegment

public LengthSegment(REFERENCEE aReferencee,
                     org.refcodes.numerical.Endianess aEndianess)

LengthSegment

public LengthSegment(REFERENCEE aReferencee,
                     int aLengthWidth,
                     org.refcodes.numerical.Endianess aEndianess)

LengthSegment

public LengthSegment(REFERENCEE aReferencee,
                     int aLengthWidth)

LengthSegment

public LengthSegment(REFERENCEE aReferencee)

LengthSegment

public LengthSegment(REFERENCEE aReferencee,
                     TransmissionMetrics aTransmissionMetrics)

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<REFERENCEE extends Transmission>

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<REFERENCEE extends Transmission>

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.

getReferencee

public REFERENCEE getReferencee()

Specified by:

getReferencee in interface org.refcodes.mixin.ReferenceeAccessor<REFERENCEE extends Transmission>

setReferencee

public void setReferencee(REFERENCEE aDecoratee)

Specified by:

setReferencee in interface org.refcodes.mixin.ReferenceeAccessor.ReferenceeMutator<REFERENCEE extends Transmission>