Class StringKeyAnalyzer
java.lang.Object
org.apache.commons.collections4.trie.KeyAnalyzer<String>
org.apache.commons.collections4.trie.analyzer.StringKeyAnalyzer
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringKeyAnalyzerA singleton instance ofStringKeyAnalyzer.static final intThe number of bits perCharacter.Fields inherited from class org.apache.commons.collections4.trie.KeyAnalyzer
EQUAL_BIT_KEY, NULL_BIT_KEY, OUT_OF_BOUNDS_BIT_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintbitIndex(String key, int offsetInBits, int lengthInBits, String other, int otherOffsetInBits, int otherLengthInBits) Returns the n-th different bit between key and other.intReturns the number of bits per element in the key.booleanReturns whether or not a bit is set.booleanDetermines whether or not the given prefix (from offset to length) is a prefix of the given key.intlengthInBits(String key) Returns the length of the Key in bits.Methods inherited from class org.apache.commons.collections4.trie.KeyAnalyzer
compareMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Field Details
-
INSTANCE
A singleton instance ofStringKeyAnalyzer. -
LENGTH
-
-
Constructor Details
-
StringKeyAnalyzer
-
-
Method Details
-
bitIndex
public int bitIndex(String key, int offsetInBits, int lengthInBits, String other, int otherOffsetInBits, int otherLengthInBits) Description copied from class:KeyAnalyzerReturns the n-th different bit between key and other. This starts the comparison in key at 'offsetInBits' and goes for 'lengthInBits' bits, and compares to the other key starting at 'otherOffsetInBits' and going for 'otherLengthInBits' bits.- Specified by:
bitIndexin classKeyAnalyzer<String>- Parameters:
key- the key to useoffsetInBits- the bit offset in the keylengthInBits- the maximum key length in bits to useother- the other key to useotherOffsetInBits- the bit offset in the other keyotherLengthInBits- the maximum key length in bits for the other key- Returns:
- the bit index where the key and other first differ
-
bitsPerElement
Description copied from class:KeyAnalyzerReturns the number of bits per element in the key. This is only useful for variable-length keys, such as Strings.- Specified by:
bitsPerElementin classKeyAnalyzer<String>- Returns:
- the number of bits per element
-
isBitSet
Description copied from class:KeyAnalyzerReturns whether or not a bit is set.- Specified by:
isBitSetin classKeyAnalyzer<String>- Parameters:
key- the key to check, may not be nullbitIndex- the bit index to checklengthInBits- the maximum key length in bits to check- Returns:
trueif the bit is set in the given key andbitIndex<lengthInBits,falseotherwise.
-
isPrefix
Description copied from class:KeyAnalyzerDetermines whether or not the given prefix (from offset to length) is a prefix of the given key.- Specified by:
isPrefixin classKeyAnalyzer<String>- Parameters:
prefix- the prefix to checkoffsetInBits- the bit offset in the keylengthInBits- the maximum key length in bits to usekey- the key to check- Returns:
trueif this is a valid prefix for the given key
-
lengthInBits
Description copied from class:KeyAnalyzerReturns the length of the Key in bits.- Specified by:
lengthInBitsin classKeyAnalyzer<String>- Parameters:
key- the key- Returns:
- the bit length of the key
-
INSTANCE.