Module org.refcodes.serial

Package org.refcodes.serial

Class CrcSegmentDecorator<DECORATEE extends Segment>

java.lang.Object

org.refcodes.numerical.AbstractCrcMixin

org.refcodes.serial.AbstractCrcTransmissionDecorator<DECORATEE>

org.refcodes.serial.CrcSegmentDecorator<DECORATEE>

Type Parameters:

DECORATEE - The decoratee type describing the according subclass to be enriched with a CRC checksum.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.numerical.CrcAlgorithmAccessor, org.refcodes.numerical.CrcChecksumAccessor, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor, org.refcodes.numerical.CrcChecksumValidationModeAccessor, org.refcodes.numerical.CrcMixin, org.refcodes.numerical.EndianessAccessor, DecoratorSegment<DECORATEE>, Segment, Transmission, Transmission.TransmissionMixin

public class CrcSegmentDecorator<DECORATEE extends Segment>
extends AbstractCrcTransmissionDecorator<DECORATEE>
implements DecoratorSegment<DECORATEE>

A CrcSegmentDecorator wraps a Segment instance and enriches the Segment with a CRC checksum.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcAlgorithmAccessor

org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<B extends org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<B>>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmMutator, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmProperty

Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcChecksumAccessor

org.refcodes.numerical.CrcChecksumAccessor.CrcChecksumBuilder<B extends org.refcodes.numerical.CrcChecksumAccessor.CrcChecksumBuilder<B>>, org.refcodes.numerical.CrcChecksumAccessor.CrcChecksumMutator, org.refcodes.numerical.CrcChecksumAccessor.CrcChecksumProperty

Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor

org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B extends org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B>>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeMutator, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeProperty

Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcChecksumValidationModeAccessor

org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<B extends org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<B>>, org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeMutator, org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeProperty

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

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractCrcTransmissionDecorator

_crcChecksum, _decoratee, CRC_ALGORITHM, CRC_BYTE_WIDTH, CRC_CHECKSUM, CRC_CHECKSUM_BIG_ENDIAN_BYTES, CRC_CHECKSUM_CONCATENATION_MODE, CRC_CHECKSUM_HEX, CRC_CHECKSUM_LITTLE_ENDIAN_BYTES, CRC_ENDIANESS

Fields inherited from class org.refcodes.numerical.AbstractCrcMixin

_crcAlgorithm, _crcChecksumConcatenateMode, _crcChecksumValidationMode, _endianess

Constructor Summary

Constructors

Constructor	Description
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
CrcSegmentDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
CrcSegmentDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.

Methods inherited from class org.refcodes.serial.AbstractCrcTransmissionDecorator

equals, getCrcChecksum, getDecoratee, getLength, hashCode, toSchema, toSequence, toSimpleTypeMap, toString, transmitTo

Methods inherited from class org.refcodes.numerical.AbstractCrcMixin

getCrcAlgorithm, getCrcChecksumConcatenateMode, getCrcChecksumValidationMode, getEndianess

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.numerical.CrcAlgorithmAccessor

getCrcAlgorithm

Methods inherited from interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor

getCrcChecksumConcatenateMode

Methods inherited from interface org.refcodes.numerical.CrcChecksumValidationModeAccessor

getCrcChecksumValidationMode

Methods inherited from interface org.refcodes.mixin.DecorateeAccessor

getDecoratee

Methods inherited from interface org.refcodes.numerical.EndianessAccessor

getEndianess

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

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           TransmissionMetrics aTransmissionMetrics)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.numerical.Endianess aEndianess)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode,
                           org.refcodes.numerical.Endianess aEndianess)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                           org.refcodes.numerical.Endianess aEndianess)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                           org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                           org.refcodes.numerical.Endianess aEndianess)

CrcSegmentDecorator

public CrcSegmentDecorator(DECORATEE aDecoratee,
                           org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                           org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                           org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode,
                           org.refcodes.numerical.Endianess aEndianess)

Method Detail

fromTransmission

public int fromTransmission(Sequence aSequence,
                            int aOffset)
                     throws BadCrcChecksumSequenceException,
                            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:

BadCrcChecksumSequenceException - thrown in case the CRC checksum validation failed.

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

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        OutputStream aReturnStream)
                 throws IOException,
                        TransmissionException,
                        BadCrcChecksumException

(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

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:

BadCrcChecksumException - thrown in case the CRC checksum validation failed.

IOException - thrown in case reading data from the InputStream caused problems.

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