Module org.refcodes.serial

Package org.refcodes.serial

Class SectionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>,CHILD extends Section>

java.lang.Object

org.refcodes.serial.SectionComposite<ALLOC,CHILD>

Type Parameters:

ALLOC - The type of the AllocSectionDecoratorSegment describing the length of each Section element in the composite.

CHILD - The type of the Section elements to be contained in the SectionComposite.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.ChildrenAccessor<CHILD[]>, org.refcodes.mixin.LengthAccessor, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin, TransmissionComposite<CHILD>

public class SectionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>,CHILD extends Section>
extends Object
implements Section, Section.SectionMixin, TransmissionComposite<CHILD>

A SectionComposite is a Section consisting of Section elements of a variable length each: Each Section element in the composite need not be of the same size. This is achieved by wrapping each Section inside a dedicated AllocSectionDecoratorSegment being a Segment providing the resulting Section's length (with all the composite's Section instances).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.ChildrenAccessor

org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T extends Object,B extends org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T,B>>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T extends Object>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<T 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

Constructor Summary

Constructors

Constructor	Description
SectionComposite(Class<ALLOC> aAllocSegmentClass, Class<CHILD> aSegmentClass)	Constructs a SectionComposite.
SectionComposite(Class<ALLOC> aAllocSegmentClass, Class<CHILD> aSegmentClass, CHILD... aSegmentArray)	Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements.
SectionComposite(org.refcodes.factory.TypeFactory<ALLOC> aAllocSegmentFactory, org.refcodes.factory.TypeFactory<CHILD> aSegmentFactory)	Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements and using the provided factories for creating Segment and Section instances.
SectionComposite(org.refcodes.factory.TypeFactory<ALLOC> aAllocSegmentFactory, org.refcodes.factory.TypeFactory<CHILD> aSegmentFactory, CHILD... aSegmentArray)	Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements and using the provided factories for creating Segment and Section instances.

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.
CHILD[]	getChildren()
int	getLength()	Determines the overall length of this Transmission.
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
protected void	setChildren(CHILD[] aChildren)	Hook for easily setting the children.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.serial.Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

transmitTo, transmitTo

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

transmitTo

Methods inherited from interface org.refcodes.serial.TransmissionComposite

toSimpleTypeMap

Constructor Detail

SectionComposite

public SectionComposite(org.refcodes.factory.TypeFactory<ALLOC> aAllocSegmentFactory,
                        org.refcodes.factory.TypeFactory<CHILD> aSegmentFactory)

Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements and using the provided factories for creating Segment and Section instances.

Parameters:

aAllocSegmentFactory - The TypeFactory creating Segment instances.

aSegmentFactory - The TypeFactory creating Section instances.

SectionComposite

@SafeVarargs
public SectionComposite(org.refcodes.factory.TypeFactory<ALLOC> aAllocSegmentFactory,
                        org.refcodes.factory.TypeFactory<CHILD> aSegmentFactory,
                        CHILD... aSegmentArray)

Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements and using the provided factories for creating Segment and Section instances.

Parameters:

aAllocSegmentFactory - The TypeFactory creating Segment instances.

aSegmentFactory - The TypeFactory creating Section instances.

aSegmentArray - The Section elements being contained in this instance.

SectionComposite

public SectionComposite(Class<ALLOC> aAllocSegmentClass,
                        Class<CHILD> aSegmentClass)

Constructs a SectionComposite. Instances for the Segment and Section elements are created using the provided Class instances.

Parameters:

aAllocSegmentClass - The class from, which to produce the Segment elements.

aSegmentClass - The class from, which to produce the Section elements.

SectionComposite

@SafeVarargs
public SectionComposite(Class<ALLOC> aAllocSegmentClass,
                        Class<CHILD> aSegmentClass,
                        CHILD... aSegmentArray)

Constructs a SectionComposite containing the provided AllocSectionDecoratorSegment elements. Instances for the Segment and Section elements are created using the provided Class instances.

Parameters:

aAllocSegmentClass - The class from, which to produce the Segment elements.

aSegmentClass - The class from, which to produce the Section elements.

aSegmentArray - The Section elements being contained in this instance.

Method Detail

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

Specified by:

toSequence in interface TransmissionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>>

Returns:

The according instance's Sequence.

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

Specified by:

toSchema in interface TransmissionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>>

Returns:

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

getLength

public int getLength()

Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

Specified by:

getLength in interface Transmission

Specified by:

getLength in interface TransmissionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>>

Returns:

The (overall) length of the Transmission (including any sub-segments).

getChildren

public CHILD[] getChildren()

Specified by:

getChildren in interface org.refcodes.mixin.ChildrenAccessor<ALLOC extends AllocSectionDecoratorSegment<CHILD>>

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

Specified by:

receiveFrom in interface Section.SectionMixin

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.

setChildren

protected void setChildren(CHILD[] aChildren)

Hook for easily setting the children.

Parameters:

aChildren - The children to be set.