Module org.refcodes.serial
Package org.refcodes.serial
Class InvertibleSegmentDecorator<DECORATEE extends Segment>
- java.lang.Object
-
- org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>
-
- org.refcodes.serial.AbstractInvertibleTransmissionDecorator<DECORATEE>
-
- org.refcodes.serial.InvertibleSegmentDecorator<DECORATEE>
-
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.DecorateeAccessor<DECORATEE>
,org.refcodes.mixin.LengthAccessor
,Segment
,Transmission
,Transmission.TransmissionMixin
public class InvertibleSegmentDecorator<DECORATEE extends Segment> extends AbstractInvertibleTransmissionDecorator<DECORATEE> implements Segment
AInvertibleSegmentDecorator
is a transmission applying anInvertible
on outgoing bytes (as ofTransmission.transmitTo(java.io.OutputStream)
or the like) and the inverse function on any incoming bytes.- 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.Segment
Segment.SegmentMixin
-
Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission
Transmission.TransmissionMixin
-
-
Field Summary
-
Fields inherited from class org.refcodes.serial.AbstractInvertibleTransmissionDecorator
_bijectiveFunction, _inverseFunction
-
Fields inherited from class org.refcodes.serial.AbstractTransmissionDecorator
_decoratee
-
-
Constructor Summary
Constructors Constructor Description InvertibleSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)
InvertibleSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
fromTransmission(Sequence aSequence, int aOffset)
(Re-)initializes this instance with the the givenSequence
data.void
receiveFrom(InputStream aInputStream, OutputStream aReturnStream)
(Re-)initializes this instance by receiving the accordingSequence
from the givenInputStream
.-
Methods inherited from class org.refcodes.serial.AbstractInvertibleTransmissionDecorator
toSchema, toTransmission, transmitTo
-
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.Segment
fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom
-
Methods inherited from interface org.refcodes.serial.Transmission
getLength, toSchema, toSimpleTypeMap, toTransmission, transmitTo, transmitTo
-
-
-
-
Method Detail
-
fromTransmission
public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
(Re-)initializes this instance with the the givenSequence
data.- Specified by:
fromTransmission
in interfaceSegment
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.- Returns:
- The index after the last offset into the given
Sequence
processed by this method. - Throws:
TransmissionException
- thrown in case a givenSequence
cannot be processed.
-
receiveFrom
public void receiveFrom(InputStream aInputStream, OutputStream aReturnStream) throws IOException, TransmissionException
(Re-)initializes this instance by receiving the accordingSequence
from the givenInputStream
. Implementations providing error correction methods use the provided feedbackOutputStream
to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.- Specified by:
receiveFrom
in interfaceSegment
- Parameters:
aInputStream
- TheInputStream
from which to read the instance's (re-)initializationSequence
from.aReturnStream
- AnOutputStream
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 theInputStream
caused problems.TransmissionException
- thrown in case a given transmission cannot be processed.
-
-