Package dev.getelements.elements.rt.transact.unix

Enum Class UnixFSChecksumAlgorithm

java.lang.Object

java.lang.Enum<UnixFSChecksumAlgorithm>

dev.getelements.elements.rt.transact.unix.UnixFSChecksumAlgorithm

All Implemented Interfaces:

Serializable, Comparable<UnixFSChecksumAlgorithm>, Constable

public enum UnixFSChecksumAlgorithm
extends Enum<UnixFSChecksumAlgorithm>

Which checksum algorithm to use when committing the transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	UnixFSChecksumAlgorithm.Algorithm
static interface	UnixFSChecksumAlgorithm.ChannelCheckable	Defines a Checksum-able type which is backed by a SeekableByteChannel or subclass.
static interface	UnixFSChecksumAlgorithm.Checkable	Defines a Checksum-able Struct type.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADLER_32	Uses Adler32
CRC_32	Uses CRC32

Method Summary

Modifier and Type	Method	Description
long	compute(UnixFSChecksumAlgorithm.ChannelCheckable checkable)	Computes the checksum and then returns the value.
void	compute(UnixFSChecksumAlgorithm.Checkable checkable)	Computes the checksum and then sets the UnixFSChecksumAlgorithm.Checkable.checksum() value.
boolean	isValid(long value, UnixFSChecksumAlgorithm.ChannelCheckable checkable)	Checks if this the supplied UnixFSChecksumAlgorithm.ChannelCheckable is valid.
boolean	isValid(UnixFSChecksumAlgorithm.Checkable checkable)	Checks if this the supplied UnixFSChecksumAlgorithm.Checkable is valid.
protected abstract UnixFSChecksumAlgorithm.Algorithm	newAlgorithm()
static UnixFSChecksumAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnixFSChecksumAlgorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CRC_32

public static final UnixFSChecksumAlgorithm CRC_32

Uses CRC32

ADLER_32

public static final UnixFSChecksumAlgorithm ADLER_32

Uses Adler32

Method Details

values

public static UnixFSChecksumAlgorithm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UnixFSChecksumAlgorithm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isValid

public boolean isValid(UnixFSChecksumAlgorithm.Checkable checkable)

Checks if this the supplied UnixFSChecksumAlgorithm.Checkable is valid.

Parameters:

checkable -

Returns:

true if valid, false otherwise

isValid

public boolean isValid(long value,
 UnixFSChecksumAlgorithm.ChannelCheckable checkable)
                throws IOException

Checks if this the supplied UnixFSChecksumAlgorithm.ChannelCheckable is valid.

Parameters:

checkable -

Returns:

true if valid, false otherwise

Throws:

IOException

newAlgorithm

protected abstract UnixFSChecksumAlgorithm.Algorithm newAlgorithm()

compute

public void compute(UnixFSChecksumAlgorithm.Checkable checkable)

Computes the checksum and then sets the UnixFSChecksumAlgorithm.Checkable.checksum() value. This will compute the checksum for the UnixFSChecksumAlgorithm.Checkable from the current bytebuffer position the buffer's current limit. It will then write the value to the struct member and to the bytebuffer.

Parameters:

checkable - the structure to compute

compute

public long compute(UnixFSChecksumAlgorithm.ChannelCheckable checkable)
             throws IOException

Computes the checksum and then returns the value. This checks the entire contents of the channel from the current position to the ending position.

Parameters:

checkable - the structure to compute

Throws:

IOException