Module org.refcodes.serial

Package org.refcodes.serial

Class AllocSegmentBody<DECORATEE extends Section>

java.lang.Object

org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>

org.refcodes.serial.AllocSegmentBody<DECORATEE>

Type Parameters:

DECORATEE - The type of the Segment decoratee.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.LengthAccessor, AllocLengthAccessor, AllocLengthAccessor.AllocLengthMutator, AllocLengthAccessor.AllocLengthProperty, Segment, Transmission, Transmission.TransmissionMixin

public class AllocSegmentBody<DECORATEE extends Section>
extends AbstractTransmissionDecorator<DECORATEE>
implements Segment, AllocLengthAccessor.AllocLengthProperty

An AllocSegmentBody provides an Segment with an allocation length. An AllocSegmentHead provides the allocation length for a AllocSegmentBody. Therefore the AllocSegmentHead references a AllocSegmentBody. The AllocSegmentHead manages the Sequence regarding the allocation length whereas the AllocSegmentBody manages the decorated Segment by harnessing the allocation length provided by the AllocSegmentHead.

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.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.Segment

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractTransmissionDecorator

_decoratee

Constructor Summary

Constructors

Constructor	Description
AllocSegmentBody(DECORATEE aDecoratee)	Constructs the decorator with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
int	getAllocLength()	Retrieves the allocated length.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
void	setAllocLength(int aValue)	Sets the allocated length.
Schema	toSchema()	Retrieves the Schema representing the Transmission.

Methods inherited from class org.refcodes.serial.AbstractTransmissionDecorator

equals, getDecoratee, getLength, hashCode, toSimpleTypeMap, toString, toTransmission

Methods inherited from interface org.refcodes.serial.AllocLengthAccessor.AllocLengthProperty

letAllocLength

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

fromInputStream, getLength, toSimpleTypeMap, toTransmission, transmitTo, transmitTo, transmitTo

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

transmitTo

Constructor Detail

AllocSegmentBody

public AllocSegmentBody(DECORATEE aDecoratee)

Constructs the decorator with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.

Parameters:

aDecoratee - The decoratee used for this decorator.

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

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

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.

getAllocLength

public int getAllocLength()

Retrieves the allocated length.

Specified by:

getAllocLength in interface AllocLengthAccessor

Returns:

The allocated length.

setAllocLength

public void setAllocLength(int aValue)

Sets the allocated length.

Specified by:

setAllocLength in interface AllocLengthAccessor.AllocLengthMutator

Parameters:

aValue - The allocated length.

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

Returns:

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