Module org.refcodes.serial
Package org.refcodes.serial
Class AllocSectionDecoratorSegment<DECORATEE extends Section>
- java.lang.Object
-
- org.refcodes.serial.AbstractReferenceeLengthSegment<DECORATEE>
-
- org.refcodes.serial.AbstractLengthDecoratorSegment<DECORATEE>
-
- org.refcodes.serial.AllocSectionDecoratorSegment<DECORATEE>
-
- Type Parameters:
DECORATEE
- The type of theSection
decoratee.
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.DecorateeAccessor<DECORATEE>
,org.refcodes.mixin.LengthAccessor
,org.refcodes.numerical.EndianessAccessor
,AllocLengthAccessor
,DecoratorSegment<DECORATEE>
,LengthWidthAccessor
,Segment
,Transmission
,Transmission.TransmissionMixin
public class AllocSectionDecoratorSegment<DECORATEE extends Section> extends AbstractLengthDecoratorSegment<DECORATEE> implements DecoratorSegment<DECORATEE>
AnAllocSectionDecoratorSegment
enriches anSection
with an allocation declaration being prefixed to the enrichedSection
.- 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.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.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 Modifier Constructor Description protected
AllocSectionDecoratorSegment()
(hook for theSectionComposite
)protected
AllocSectionDecoratorSegment(int aLengthWidth)
(hook for theSectionComposite
)protected
AllocSectionDecoratorSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
(hook for theSectionComposite
)AllocSectionDecoratorSegment(DECORATEE aDecoratee)
AllocSectionDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth)
AllocSectionDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
AllocSectionDecoratorSegment(DECORATEE aDecoratee, org.refcodes.numerical.Endianess aEndianess)
AllocSectionDecoratorSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
protected
AllocSectionDecoratorSegment(org.refcodes.numerical.Endianess aEndianess)
(hook for theSectionComposite
)protected
AllocSectionDecoratorSegment(TransmissionMetrics aTransmissionMetrics)
-
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
.protected void
setDecoratee(DECORATEE aDecoratee)
Hook and package local setter for theSectionComposite
class.-
Methods inherited from class org.refcodes.serial.AbstractLengthDecoratorSegment
getDecoratee, getLength, toSchema, toSequence, toString, transmitTo
-
Methods inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment
equals, getAllocLength, getEndianess, getLengthWidth, hashCode, toSimpleTypeMap
-
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, toSequence, toSimpleTypeMap, transmitTo, transmitTo
-
-
-
-
Constructor Detail
-
AllocSectionDecoratorSegment
protected AllocSectionDecoratorSegment(TransmissionMetrics aTransmissionMetrics)
-
AllocSectionDecoratorSegment
public AllocSectionDecoratorSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
-
AllocSectionDecoratorSegment
protected AllocSectionDecoratorSegment()
(hook for theSectionComposite
)
-
AllocSectionDecoratorSegment
protected AllocSectionDecoratorSegment(org.refcodes.numerical.Endianess aEndianess)
(hook for theSectionComposite
)
-
AllocSectionDecoratorSegment
protected AllocSectionDecoratorSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
(hook for theSectionComposite
)
-
AllocSectionDecoratorSegment
protected AllocSectionDecoratorSegment(int aLengthWidth)
(hook for theSectionComposite
)
-
AllocSectionDecoratorSegment
public AllocSectionDecoratorSegment(DECORATEE aDecoratee, org.refcodes.numerical.Endianess aEndianess)
-
AllocSectionDecoratorSegment
public AllocSectionDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
-
AllocSectionDecoratorSegment
public AllocSectionDecoratorSegment(DECORATEE aDecoratee, int aLengthWidth)
-
AllocSectionDecoratorSegment
public AllocSectionDecoratorSegment(DECORATEE aDecoratee)
-
-
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
- Overrides:
fromTransmission
in classAbstractReferenceeLengthSegment<DECORATEE extends Section>
- 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
- Overrides:
receiveFrom
in classAbstractReferenceeLengthSegment<DECORATEE extends Section>
- 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.
-
setDecoratee
protected void setDecoratee(DECORATEE aDecoratee)
Hook and package local setter for theSectionComposite
class.- Parameters:
aDecoratee
- The decoratee to be set.
-
-