Module org.refcodes.numerical

Package org.refcodes.numerical

Class AbstractCrcMixin

java.lang.Object

org.refcodes.numerical.AbstractCrcMixin

All Implemented Interfaces:

ChecksumValidationModeAccessor, CrcAlgorithmAccessor, CrcChecksumConcatenateModeAccessor, CrcMixin, EndianessAccessor

public abstract class AbstractCrcMixin
extends Object
implements CrcMixin

A AbstractCrcMixin provides a class based implementation of the CrcMixin 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

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 the CrcAlgorithm property.
org.refcodes.mixin.ConcatenateMode	getCrcChecksumConcatenateMode()	Retrieves the ConcatenateMode from the CRC checksum ConcatenateMode property.
Endianess	getEndianess()	Retrieves the value from the Endianess property.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

_crcAlgorithm

protected CrcAlgorithm _crcAlgorithm

_checksumValidationMode

protected ChecksumValidationMode _checksumValidationMode

_crcChecksumConcatenateMode

protected org.refcodes.mixin.ConcatenateMode _crcChecksumConcatenateMode

_endianess

protected Endianess _endianess

Constructor Details

AbstractCrcMixin

public AbstractCrcMixin(CrcAlgorithm aCrcAlgorithm,
 org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
 ChecksumValidationMode aChecksumValidationMode,
 Endianess aEndianess)

Constructs an according instance from the given arguments.

Parameters:

aCrcAlgorithm - The CrcAlgorithm 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 - The Endianess to use when calculating the CRC checksum.

Method Details

getCrcChecksumConcatenateMode

public org.refcodes.mixin.ConcatenateMode getCrcChecksumConcatenateMode()

Retrieves the ConcatenateMode from the CRC checksum ConcatenateMode property.

Specified by:

getCrcChecksumConcatenateMode in interface CrcChecksumConcatenateModeAccessor

Returns:

The ConcatenateMode stored by the CRC checksum ConcatenateMode property.

getChecksumValidationMode

public ChecksumValidationMode getChecksumValidationMode()

Retrieves the validation mode from the validation mode property.

Specified by:

getChecksumValidationMode in interface ChecksumValidationModeAccessor

Returns:

The validation mode stored by the validation mode property.

getCrcAlgorithm

public CrcAlgorithm getCrcAlgorithm()

Retrieves the value from the CrcAlgorithm property.

Specified by:

getCrcAlgorithm in interface CrcAlgorithmAccessor

Returns:

The name stored by the CrcAlgorithm property.

getEndianess

public Endianess getEndianess()

Retrieves the value from the Endianess property.

Specified by:

getEndianess in interface EndianessAccessor

Returns:

The name stored by the Endianess property.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object