Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractMagicBytesTransmissionDispatcher<CHILD extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmissionDispatcher<CHILD>

All Implemented Interfaces:

Serializable, Iterable<CHILD>, org.refcodes.mixin.ChildrenAccessor<CHILD[]>, org.refcodes.mixin.LengthAccessor, Transmission

Direct Known Subclasses:

MagicBytesSectionDispatcher, MagicBytesSegmentDispatcher

public class AbstractMagicBytesTransmissionDispatcher<CHILD extends Transmission>
extends Object
implements Transmission, Iterable<CHILD>, org.refcodes.mixin.ChildrenAccessor<CHILD[]>

The AbstractMagicBytesTransmissionDispatcher dispatches a transmission to one of the aggregated Transmission instances depending on the magic number provided by the transmission. A transmission is passed to each of the aggregated Transmission instances till one Transmission accepts the transmission, e.g. until a Transmission does not throw a BadMagicBytesException. Attention: A Transmission throwing a TransmissionException other than a BadMagicBytesException is considered to be responsible for the transmission so that dispatching is *not* continued with the succeeding Transmission! The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission.

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

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected CHILD[]	_children
protected int	_readLimit
protected CHILD	_responsibility
static int	DEFAULT_READ_LIMIT	The responsible (if not specified otherwise) maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMagicBytesTransmissionDispatcher()	Constructs an empty AbstractMagicBytesTransmissionDispatcher for sub-classes to use having the responsibility to set the children by themselves.
	AbstractMagicBytesTransmissionDispatcher(int aReadLimit, CHILD... aSegments)	Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.
	AbstractMagicBytesTransmissionDispatcher(CHILD... aSegments)	Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.
	AbstractMagicBytesTransmissionDispatcher(Collection<CHILD> aSegments)	Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.
	AbstractMagicBytesTransmissionDispatcher(Collection<CHILD> aSegments, int aReadLimit)	Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.

Method Summary

Modifier and Type	Method	Description
CHILD[]	getChildren()
int	getLength()	Returns the length of the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
CHILD	getResponsibility()	The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
Iterator<CHILD>	iterator()
Schema	toSchema()	Retrieves the Schema representing the Transmission.
org.refcodes.struct.SimpleTypeMap	toSimpleTypeMap()	Returns the responsible Transmission's SimpleTypeMap representation: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
Sequence	toTransmission()	Returns the responsible Transmission's transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
void	transmitTo(OutputStream aOutputStream)	Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
void	transmitTo(OutputStream aOutputStream, InputStream aReturnStream)	Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.
void	transmitTo(SerialTransceiver aSerialTransceiver)	Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

DEFAULT_READ_LIMIT

public static final int DEFAULT_READ_LIMIT

The responsible (if not specified otherwise) maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.

See Also:

Constant Field Values

_children

protected CHILD extends Transmission[] _children

_responsibility

protected CHILD extends Transmission _responsibility

_readLimit

protected int _readLimit

Constructor Details

AbstractMagicBytesTransmissionDispatcher

protected AbstractMagicBytesTransmissionDispatcher()

Constructs an empty AbstractMagicBytesTransmissionDispatcher for sub-classes to use having the responsibility to set the children by themselves.

AbstractMagicBytesTransmissionDispatcher

@SafeVarargs
public AbstractMagicBytesTransmissionDispatcher(CHILD... aSegments)

Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.

Parameters:

aSegments - The Transmission elements being contained in this instance.

AbstractMagicBytesTransmissionDispatcher

public AbstractMagicBytesTransmissionDispatcher(Collection<CHILD> aSegments)

Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.

Parameters:

aSegments - The Transmission elements being contained in this instance.

AbstractMagicBytesTransmissionDispatcher

@SafeVarargs
public AbstractMagicBytesTransmissionDispatcher(int aReadLimit,
CHILD... aSegments)

Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.

Parameters:

aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.

aSegments - The Transmission elements being contained in this instance.

AbstractMagicBytesTransmissionDispatcher

public AbstractMagicBytesTransmissionDispatcher(Collection<CHILD> aSegments,
int aReadLimit)

Constructs a AbstractMagicBytesTransmissionDispatcher containing the provided Transmission elements.

Parameters:

aSegments - The Transmission elements being contained in this instance.

aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.

Method Details

getLength

public int getLength()

Returns the length of the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. 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

Returns:

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

toTransmission

public Sequence toTransmission()

Returns the responsible Transmission's transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. 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.

Specified by:

toTransmission in interface Transmission

Returns:

The according instance's Sequence.

transmitTo

public void transmitTo(OutputStream aOutputStream,
InputStream aReturnStream)
                throws IOException

Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. 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.

Specified by:

transmitTo in interface Transmission

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.

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

Returns:

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

toSimpleTypeMap

public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()

Returns the responsible Transmission's SimpleTypeMap representation: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. Returns the SimpleTypeMap representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting SimpleTypeMap. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeMap in interface Transmission

Returns:

The SimpleTypeMap representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.

transmitTo

public void transmitTo(OutputStream aOutputStream)
                throws IOException

Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. Transmits the Sequence representing the implementing type's instance to the given OutputStream. This is a convenience method in case there is no feedback InputStream available (actually the Transmission.transmitTo(OutputStream, InputStream) method is invoked with null for the feedback InputStream). Override Transmission.transmitTo(OutputStream, InputStream) for your custom transmitting functionality.

Specified by:

transmitTo in interface Transmission

Parameters:

aOutputStream - The OutputStream where to write this instance's Sequence to.

Throws:

IOException - thrown in case writing data to the OutputStream caused problems.

transmitTo

public void transmitTo(SerialTransceiver aSerialTransceiver)
                throws IOException

Transmits to the responsible Transmission: The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission. Transmits the Sequence representing the implementing type's instance to the given SerialTransceiver's OutputStream. Implementations providing error correction methods use the provided SerialTransceiver's feedback InputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the transmitted data.This is a convenience method (actually the Transmission.transmitTo(OutputStream, InputStream) method is invoked). Override Transmission.transmitTo(OutputStream, InputStream) for your custom transmitting functionality.

Specified by:

transmitTo in interface Transmission

Parameters:

aSerialTransceiver - The SerialTransceiver providing the OutputStream where to write this instance's Sequence to and providing the InputStream being the return channel to handle "stop-and-wait ARQ".

Throws:

IOException - thrown in case writing data to the OutputStream caused problems.

iterator

public Iterator<CHILD> iterator()

Specified by:

iterator in interface Iterable<CHILD extends Transmission>

getChildren

public CHILD[] getChildren()

Specified by:

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

getResponsibility

public CHILD getResponsibility()

The last Transmission which was responsible for a transmission's magic bytes will be the responsible Transmission till another Transmission claims responsibility for a transmsision's magic bytes. Initially the first Transmission passed to this instance is the responsible Transmission.

Returns:

Returns the responsible Transmission.