Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractSectionDecorator<SECTION extends Section>

java.lang.Object

org.refcodes.serial.AbstractTransmissionDecorator<SECTION>

org.refcodes.serial.AbstractSectionDecorator<SECTION>

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<SECTION>, org.refcodes.mixin.LengthAccessor, Section, Transmission, Transmission.TransmissionMixin

public class AbstractSectionDecorator<SECTION extends Section>
extends AbstractTransmissionDecorator<SECTION>
implements Section

Convenience class for easily decorating a Section.

See Also:

Serialized Form

Nested Class Summary

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

Section.SectionMixin

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
AbstractSectionDecorator()
AbstractSectionDecorator(SECTION aDecoratee)	Instantiates a new abstract section decorator.

Method Summary

Modifier and Type	Method	Description
void	fromTransmission(Sequence aSequence, int aOffset, int aLength)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
Schema	toSchema()	Retrieves the Schema representing the 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.AbstractTransmissionDecorator

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.serial.Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSimpleTypeMap, toTransmission, transmitTo, transmitTo

Constructor Detail

AbstractSectionDecorator

public AbstractSectionDecorator()

AbstractSectionDecorator

public AbstractSectionDecorator(SECTION aDecoratee)

Instantiates a new abstract section decorator.

Parameters:

aDecoratee - the a decoratee

Method Detail

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.

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.

fromTransmission

public void fromTransmission(Sequence aSequence,
                             int aOffset,
                             int aLength)
                      throws TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Section

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

aLength - The length of data assigned by the Sequence.

Throws:

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

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        int aLength,
                        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 Section

Parameters:

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

aLength - The length of data assigned by the byte array.

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 InputStream bytes cannot be processed.