org.ardverk.collection

Class CharacterKeyAnalyzer

java.lang.Object

org.ardverk.collection.AbstractKeyAnalyzer<java.lang.Character>

org.ardverk.collection.CharacterKeyAnalyzer

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<java.lang.Character>, KeyAnalyzer<java.lang.Character>

public class CharacterKeyAnalyzer
extends AbstractKeyAnalyzer<java.lang.Character>

A KeyAnalyzer for Characters

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CharacterKeyAnalyzer	INSTANCE A singleton instance of the CharacterKeyAnalyzer.
static int	LENGTH The length of a Character in bits

Fields inherited from interface org.ardverk.collection.KeyAnalyzer

EQUAL_BIT_KEY, NULL_BIT_KEY, OUT_OF_BOUNDS_BIT_KEY

Constructor Summary

Constructors

Constructor and Description
CharacterKeyAnalyzer()

Method Summary

Modifier and Type	Method and Description
int	bitIndex(java.lang.Character key, int offsetInBits, int lengthInBits, java.lang.Character other, int otherOffsetInBits, int otherLengthInBits) Returns the n-th different bit between key and found.
int	bitsPerElement() Returns the number of bits per element in the key.
boolean	isBitSet(java.lang.Character key, int bitIndex, int lengthInBits) Returns whether or not a bit is set
boolean	isPrefix(java.lang.Character prefix, int offsetInBits, int lengthInBits, java.lang.Character key) Determines whether or not the given prefix (from offset to length) is a prefix of the given key.
int	lengthInBits(java.lang.Character key) Returns the length of the Key in bits.

Methods inherited from class org.ardverk.collection.AbstractKeyAnalyzer

compare

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

INSTANCE

public static final CharacterKeyAnalyzer INSTANCE

A singleton instance of the CharacterKeyAnalyzer.

LENGTH

public static final int LENGTH

The length of a Character in bits

See Also:

Constant Field Values

Constructor Detail

CharacterKeyAnalyzer

public CharacterKeyAnalyzer()

Method Detail

bitsPerElement

public int bitsPerElement()

Returns the number of bits per element in the key. This is only useful for variable-length keys, such as Strings.

lengthInBits

public int lengthInBits(java.lang.Character key)

Returns the length of the Key in bits.

isBitSet

public boolean isBitSet(java.lang.Character key,
                        int bitIndex,
                        int lengthInBits)

Returns whether or not a bit is set

bitIndex

public int bitIndex(java.lang.Character key,
                    int offsetInBits,
                    int lengthInBits,
                    java.lang.Character other,
                    int otherOffsetInBits,
                    int otherLengthInBits)

Returns the n-th different bit between key and found. This starts the comparison in key at 'keyStart' and goes for 'keyLength' bits, and compares to the found key starting at 'foundStart' and going for 'foundLength' bits.

isPrefix

public boolean isPrefix(java.lang.Character prefix,
                        int offsetInBits,
                        int lengthInBits,
                        java.lang.Character key)

Determines whether or not the given prefix (from offset to length) is a prefix of the given key.