Module org.refcodes.serial

Package org.refcodes.serial

Class SegmentComposite<CHILD extends Segment>

java.lang.Object

org.refcodes.serial.AbstractTransmissionComposite<CHILD>

org.refcodes.serial.SegmentComposite<CHILD>

Type Parameters:

CHILD - The type of the child elements to be contained in this instance.

All Implemented Interfaces:

Serializable, Iterable<CHILD>, org.refcodes.mixin.ChildrenAccessor<CHILD[]>, org.refcodes.mixin.LengthAccessor, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin, TransmissionComposite<CHILD>

Direct Known Subclasses:

ComplexTypeSegment

public class SegmentComposite<CHILD extends Segment>
extends AbstractTransmissionComposite<CHILD>
implements Segment, Segment.SegmentMixin, TransmissionComposite<CHILD>

The SegmentComposite is a Segment composed of multiple child Segment elements.

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

Segment.SegmentMixin

Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractTransmissionComposite

_children

Constructor Summary

Constructors

Constructor	Description
SegmentComposite(CHILD... aSegments)
SegmentComposite(Collection<CHILD> aSegments)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
int	hashCode()
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
String	toString()

Methods inherited from class org.refcodes.serial.AbstractTransmissionComposite

getChildren, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.ChildrenAccessor

getChildren

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.refcodes.serial.Segment

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

getLength, toSimpleTypeMap, toTransmission

Constructor Detail

SegmentComposite

public SegmentComposite(Collection<CHILD> aSegments)

SegmentComposite

@SafeVarargs
public SegmentComposite(CHILD... aSegments)

Method Detail

fromTransmission

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

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

Specified by:

fromTransmission in interface Segment

Parameters:

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

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

Returns:

The index after the last offset into the given Sequence processed by this method.

Throws:

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

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        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 Segment

Specified by:

receiveFrom in interface Segment.SegmentMixin

Parameters:

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

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

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<CHILD extends Segment>

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class AbstractTransmissionComposite<CHILD extends Segment>