- java.lang.Object
-
- org.refcodes.numerical.AbstractCrcMixin
-
- All Implemented Interfaces:
ChecksumValidationModeAccessor
,CrcAlgorithmAccessor
,CrcChecksumConcatenateModeAccessor
,CrcMixin
,EndianessAccessor
public abstract class AbstractCrcMixin extends Object implements CrcMixin
AAbstractCrcMixin
provides a class based implementation of theCrcMixin
for CRC checksum creation and validation of accompanied data.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.numerical.ChecksumValidationModeAccessor
ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<B extends ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<B>>, ChecksumValidationModeAccessor.ChecksumValidationModeMutator, ChecksumValidationModeAccessor.ChecksumValidationModeProperty
-
Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcAlgorithmAccessor
CrcAlgorithmAccessor.CrcAlgorithmBuilder<B extends CrcAlgorithmAccessor.CrcAlgorithmBuilder<B>>, CrcAlgorithmAccessor.CrcAlgorithmMutator, CrcAlgorithmAccessor.CrcAlgorithmProperty
-
Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor
CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B extends CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B>>, CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeMutator, CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeProperty
-
Nested classes/interfaces inherited from interface org.refcodes.numerical.EndianessAccessor
EndianessAccessor.EndianessBuilder<B extends EndianessAccessor.EndianessBuilder<B>>, EndianessAccessor.EndianessMutator, EndianessAccessor.EndianessProperty
-
-
Field Summary
Fields Modifier and Type Field Description protected ChecksumValidationMode
_checksumValidationMode
protected CrcAlgorithm
_crcAlgorithm
protected org.refcodes.mixin.ConcatenateMode
_crcChecksumConcatenateMode
protected Endianess
_endianess
-
Constructor Summary
Constructors Constructor Description AbstractCrcMixin(CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, ChecksumValidationMode aChecksumValidationMode, Endianess aEndianess)
Constructs an according instance from the given arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
ChecksumValidationMode
getChecksumValidationMode()
Retrieves the validation mode from the validation mode property.CrcAlgorithm
getCrcAlgorithm()
Retrieves the value from theCrcAlgorithm
property.org.refcodes.mixin.ConcatenateMode
getCrcChecksumConcatenateMode()
Retrieves theConcatenateMode
from the CRC checksumConcatenateMode
property.Endianess
getEndianess()
Retrieves the value from theEndianess
property.int
hashCode()
-
-
-
Field Detail
-
_crcAlgorithm
protected CrcAlgorithm _crcAlgorithm
-
_checksumValidationMode
protected ChecksumValidationMode _checksumValidationMode
-
_crcChecksumConcatenateMode
protected org.refcodes.mixin.ConcatenateMode _crcChecksumConcatenateMode
-
_endianess
protected Endianess _endianess
-
-
Constructor Detail
-
AbstractCrcMixin
public AbstractCrcMixin(CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, ChecksumValidationMode aChecksumValidationMode, Endianess aEndianess)
Constructs an according instance from the given arguments.- Parameters:
aCrcAlgorithm
- TheCrcAlgorithm
to be used for CRC checksum calculation.aCrcChecksumConcatenateMode
- The mode of concatenation to use when enriching data with a CRC checksum.aChecksumValidationMode
- The mode of operation when validating provided CRC checksums against calculated ones.aEndianess
- TheEndianess
to use when calculating the CRC checksum.
-
-
Method Detail
-
getCrcChecksumConcatenateMode
public org.refcodes.mixin.ConcatenateMode getCrcChecksumConcatenateMode()
Retrieves theConcatenateMode
from the CRC checksumConcatenateMode
property.- Specified by:
getCrcChecksumConcatenateMode
in interfaceCrcChecksumConcatenateModeAccessor
- Returns:
- The
ConcatenateMode
stored by the CRC checksumConcatenateMode
property.
-
getChecksumValidationMode
public ChecksumValidationMode getChecksumValidationMode()
Retrieves the validation mode from the validation mode property.- Specified by:
getChecksumValidationMode
in interfaceChecksumValidationModeAccessor
- Returns:
- The validation mode stored by the validation mode property.
-
getCrcAlgorithm
public CrcAlgorithm getCrcAlgorithm()
Retrieves the value from theCrcAlgorithm
property.- Specified by:
getCrcAlgorithm
in interfaceCrcAlgorithmAccessor
- Returns:
- The name stored by the
CrcAlgorithm
property.
-
getEndianess
public Endianess getEndianess()
Retrieves the value from theEndianess
property.- Specified by:
getEndianess
in interfaceEndianessAccessor
- Returns:
- The name stored by the
Endianess
property.
-
-