Module org.refcodes.serial

Package org.refcodes.serial

Class CrcSectionDecorator<DECORATEE extends Section>

java.lang.Object

org.refcodes.numerical.AbstractCrcMixin

org.refcodes.serial.AbstractCrcTransmissionDecorator<DECORATEE>

org.refcodes.serial.CrcSectionDecorator<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, DecoratorSection<DECORATEE>, Section, Transmission, Transmission.TransmissionMixin

public class CrcSectionDecorator<DECORATEE extends Section>
extends AbstractCrcTransmissionDecorator<DECORATEE>
implements DecoratorSection<DECORATEE>

A CrcSectionDecorator wraps a Section instance and enriches the the Section 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.Section

Section.SectionMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.numerical.AbstractCrcMixin

_crcAlgorithm, _crcChecksumConcatenateMode, _crcChecksumValidationMode, _endianess

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

Constructor Summary

Constructors

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

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.
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.

Methods inherited from class org.refcodes.numerical.AbstractCrcMixin

getCrcAlgorithm, getCrcChecksumConcatenateMode, getCrcChecksumValidationMode, getEndianess

Methods inherited from class org.refcodes.serial.AbstractCrcTransmissionDecorator

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

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 class java.lang.Object

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

Methods inherited from interface org.refcodes.serial.Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

fromInputStream, getLength, toSchema, toSimpleTypeMap, toTransmission, transmitTo, transmitTo, transmitTo

Constructor Detail

CrcSectionDecorator

public CrcSectionDecorator(DECORATEE aDecoratee,
                           TransmissionMetrics aTransmissionMetrics)

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

CrcSectionDecorator

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

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,
                        int aLength,
                        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 Section

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:

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