Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractInvertibleTransmissionDecorator<DECORATEE extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>

org.refcodes.serial.AbstractInvertibleTransmissionDecorator<DECORATEE>

Type Parameters:

DECORATEE - The Transmission type describing the Transmission subclass to be enriched.s

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Schemable<SerialSchema>, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

InvertibleSectionDecorator, InvertibleSegmentDecorator

public abstract class AbstractInvertibleTransmissionDecorator<DECORATEE extends Transmission>
extends AbstractTransmissionDecorator<DECORATEE>

An abstract implementation of bijective and inverse functions applied to the decoratee's transmitting and receiving methods.

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

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected org.refcodes.numerical.BijectiveFunction<Byte,Byte>	_bijectiveFunction
protected org.refcodes.numerical.InverseFunction<Byte,Byte>	_inverseFunction

Fields inherited from class org.refcodes.serial.AbstractTransmissionDecorator

_decoratee

Constructor Summary

Constructors

Constructor	Description
AbstractInvertibleTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)	Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
AbstractInvertibleTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)	Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.

Method Summary

Modifier and Type	Method	Description
SerialSchema	toSchema()	Retrieves the SerialSchema representing the Transmission.
Sequence	toSequence()	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.AbstractTransmissionDecorator

equals, getDecoratee, getLength, hashCode, toSimpleTypeMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.serial.Transmission

transmitTo, transmitTo

Field Details

_bijectiveFunction

protected org.refcodes.numerical.BijectiveFunction<Byte,Byte> _bijectiveFunction

_inverseFunction

protected org.refcodes.numerical.InverseFunction<Byte,Byte> _inverseFunction

Constructor Details

AbstractInvertibleTransmissionDecorator

public AbstractInvertibleTransmissionDecorator(DECORATEE aDecoratee,
 org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)

Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.

Parameters:

aDecoratee - The decorator having applied the Invertible's BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.

aInvertible - The Invertible providing the BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.

AbstractInvertibleTransmissionDecorator

public AbstractInvertibleTransmissionDecorator(DECORATEE aDecoratee,
 org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction,
 org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)

Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.

Parameters:

aDecoratee - The decorator having applied the BijectiveFunction to encode and the InverseFunction to decode any data being delegated.

aBijectiveFunction - The BijectiveFunction to encode any data being delegated.

aInverseFunction - The InverseFunction to decode any data being delegated.

Method Details

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.

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.

toSequence

public Sequence toSequence()

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. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.

Specified by:

toSequence in interface Transmission

Overrides:

toSequence in class AbstractTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The according instance's Sequence.

toSchema

public SerialSchema toSchema()

Retrieves the SerialSchema representing the Transmission. Retrieving a SerialSchema 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.

Returns:

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