Modifier and Type	Class and Description
pack-priv abstract static class	AbstractBitwiseTrie.BasicEntry<K, V> A basic implementation of `Entry`.

Modifier and Type	Field and Description
private final KeyAnalyzer<? super K>	keyAnalyzer The `KeyAnalyzer` that's being used to build the PATRICIA `Trie`.
private static final long	serialVersionUID

Access	Constructor and Description
protected	AbstractBitwiseTrie(final KeyAnalyzer<? super K> the `KeyAnalyzer` to use keyAnalyzer) Constructs a new `Trie` using the given `KeyAnalyzer`.

Method Summary

Modifier and Type	Method and Description
pack-priv final int	bitIndex(final K key, final K foundKey) Utility method for calling `KeyAnalyzer#bitIndex(Object, int, int, Object, int, int)`.
pack-priv final int	bitsPerElement() Returns the number of bits per element in the key
pack-priv final K	castKey(final Object key) A utility method to cast keys.
pack-priv static boolean	compare(final Object a, final Object b) Returns true if both values are either null or equal.
pack-priv final boolean	compareKeys(final K key, final K other) An utility method for calling `KeyAnalyzer#compare(Object, Object)`
protected KeyAnalyzer<? super K>	Returns: the `KeyAnalyzer` used by this `Trie` getKeyAnalyzer() Returns the `KeyAnalyzer` that constructed the `Trie`.
pack-priv final boolean	isBitSet(final K key, final int bitIndex, final int lengthInBits) Returns whether or not the given bit on the key is set or false if the key is null.
pack-priv final int	lengthInBits(final K key) Returns the length of the given key in bits
public String	toString() Overrides java.util.AbstractMap.toString. Returns a string representation of this map.

Inherited from java.util.AbstractMap:: clear clone containsKey containsValue entrySet equals get hashCode isEmpty keySet put putAll remove size values

keyAnalyzer	back to summary
private final KeyAnalyzer<? super K> keyAnalyzer The `KeyAnalyzer` that's being used to build the PATRICIA `Trie`.

serialVersionUID	back to summary
private static final long serialVersionUID

AbstractBitwiseTrie	back to summary
protected AbstractBitwiseTrie(final KeyAnalyzer<? super K> keyAnalyzer) Constructs a new `Trie` using the given `KeyAnalyzer`. Parameters keyAnalyzer:KeyAnalyzer<? super K> the `KeyAnalyzer` to use

Method Detail

bitIndex	back to summary
pack-priv final int bitIndex(final K key, final K foundKey) Utility method for calling `KeyAnalyzer#bitIndex(Object, int, int, Object, int, int)`.

bitsPerElement back to summary

bitsPerElement	back to summary
pack-priv final int bitsPerElement() Returns the number of bits per element in the key See Also `KeyAnalyzer#bitsPerElement()`

pack-priv final int bitsPerElement()

Returns the number of bits per element in the key

See Also: KeyAnalyzer#bitsPerElement()

castKey	back to summary
pack-priv final K castKey(final Object key) A utility method to cast keys. It actually doesn't cast anything. It's just fooling the compiler! Annotations @SuppressWarnings:unchecked

castKey

back to summary

pack-priv final K castKey(final Object key)

A utility method to cast keys. It actually doesn't cast anything. It's just fooling the compiler!

Annotations

@SuppressWarnings:unchecked

compare	back to summary
pack-priv static boolean compare(final Object a, final Object b) Returns true if both values are either null or equal.

compareKeys	back to summary
pack-priv final boolean compareKeys(final K key, final K other) An utility method for calling `KeyAnalyzer#compare(Object, Object)`

getKeyAnalyzer back to summary

getKeyAnalyzer	back to summary
protected KeyAnalyzer<? super K> getKeyAnalyzer() Returns the `KeyAnalyzer` that constructed the `Trie`. Returns:KeyAnalyzer<? super K> the `KeyAnalyzer` used by this `Trie`

protected KeyAnalyzer<? super K> getKeyAnalyzer()

Returns the KeyAnalyzer that constructed the Trie.

Returns:KeyAnalyzer<? super K>: the KeyAnalyzer used by this Trie

isBitSet back to summary

isBitSet	back to summary
pack-priv final boolean isBitSet(final K key, final int bitIndex, final int lengthInBits) Returns whether or not the given bit on the key is set or false if the key is null. See Also `KeyAnalyzer#isBitSet(Object, int, int)`

pack-priv final boolean isBitSet(final K key, final int bitIndex, final int lengthInBits)

Returns whether or not the given bit on the key is set or false if the key is null.

See Also: KeyAnalyzer#isBitSet(Object, int, int)

lengthInBits back to summary

lengthInBits	back to summary
pack-priv final int lengthInBits(final K key) Returns the length of the given key in bits See Also `KeyAnalyzer#lengthInBits(Object)`

pack-priv final int lengthInBits(final K key)

Returns the length of the given key in bits

See Also: KeyAnalyzer#lengthInBits(Object)

toString back to summary

toString	back to summary
public String toString() Overrides java.util.AbstractMap.toString. Doc from java.util.AbstractMap.toString. Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's `entrySet` view's iterator, enclosed in braces (`"{}"`). Adjacent mappings are separated by the characters `", "` (comma and space). Each key-value mapping is rendered as the key followed by an equals sign (`"="`) followed by the associated value. Keys and values are converted to strings as by `String#valueOf(Object)`. Returns:String a string representation of this map Annotations @Override

public String toString()

Overrides java.util.AbstractMap.toString.

Doc from java.util.AbstractMap.toString.

Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's entrySet view's iterator, enclosed in braces ("{}"). Adjacent mappings are separated by the characters ", " (comma and space). Each key-value mapping is rendered as the key followed by an equals sign ("=") followed by the associated value. Keys and values are converted to strings as by String#valueOf(Object).

Returns:String

a string representation of this map

Annotations

@Override

org.apache.commons.collections4.trie back to summary

pack-priv abstract Class AbstractBitwiseTrie.BasicEntry<K, V>

Class Inheritance

extends Object
implements Map.Entry<K, V>, Serializable

java.lang.Object
org.apache.commons.collections4.trie.AbstractBitwiseTrie.BasicEntry

All Implemented Interfaces

java.io.Serializable, java.util.Map.Entry

Known Direct Subclasses

org.apache.commons.collections4.trie.AbstractPatriciaTrie.TrieEntry

A basic implementation of Entry.

Field Summary

Modifier and Type	Field and Description
protected K	key
private static final long	serialVersionUID
protected V	value

Constructor Summary

Access	Constructor and Description
public	BasicEntry(final K key)
public	BasicEntry(final K key, final V value)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object object to be compared for equality with this map entry o) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Compares the specified object with this entry for equality.
public K	getKey() Implements java.util.Map.Entry.getKey. Returns the key corresponding to this entry.
public V	getValue() Implements java.util.Map.Entry.getValue. Returns the value corresponding to this entry.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Returns the hash code value for this map entry.
public V	setKeyValue(final K key, final V value) Replaces the current key and value with the provided key & value.
public V	setValue(final V new value to be stored in this entry value) Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

key	back to summary
protected K key

serialVersionUID	back to summary
private static final long serialVersionUID

value	back to summary
protected V value

Constructor Detail

BasicEntry	back to summary
public BasicEntry(final K key)

BasicEntry	back to summary
public BasicEntry(final K key, final V value)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Doc from java.util.Map.Entry.equals. Compares the specified object with this entry for equality. Returns `true` if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries `e1` and `e2` represent the same mapping if (e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) && (e1.getValue()==null ? e2.getValue()==null : e1.getValue().equals(e2.getValue())) This ensures that the `equals` method works properly across different implementations of the `Map.Entry` interface. Parameters o:Object object to be compared for equality with this map entry Returns:boolean `true` if the specified object is equal to this map entry Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Doc from java.util.Map.Entry.equals.

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries e1 and e2 represent the same mapping if

    (e1.getKey()==null ?
     e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
    (e1.getValue()==null ?
     e2.getValue()==null : e1.getValue().equals(e2.getValue()))

This ensures that the equals method works properly across different implementations of the Map.Entry interface.

Parameters

o:Object: object to be compared for equality with this map entry

Returns:boolean

true if the specified object is equal to this map entry

Annotations

@Override

getKey	back to summary
public K getKey() Implements java.util.Map.Entry.getKey. Doc from java.util.Map.Entry.getKey. Returns the key corresponding to this entry. Returns:K the key corresponding to this entry Annotations @Override

getKey

back to summary

public K getKey()

Implements java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:K

the key corresponding to this entry

Annotations

@Override

getValue back to summary

getValue	back to summary
public V getValue() Implements java.util.Map.Entry.getValue. Doc from java.util.Map.Entry.getValue. Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's `remove` operation), the results of this call are undefined. Returns:V the value corresponding to this entry Annotations @Override

public V getValue()

Implements java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:V

the value corresponding to this entry

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Doc from java.util.Map.Entry.hashCode. Returns the hash code value for this map entry. The hash code of a map entry `e` is defined to be: (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ (e.getValue()==null ? 0 : e.getValue().hashCode()) This ensures that `e1.equals(e2)` implies that `e1.hashCode()==e2.hashCode()` for any two Entries `e1` and `e2`, as required by the general contract of `Object.hashCode`. Returns:int the hash code value for this map entry Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Doc from java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry. The hash code of a map entry e is defined to be:

    (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
    (e.getValue()==null ? 0 : e.getValue().hashCode())

This ensures that e1.equals(e2) implies that e1.hashCode()==e2.hashCode() for any two Entries e1 and e2, as required by the general contract of Object.hashCode.

Returns:int

the hash code value for this map entry

Annotations

@Override

setKeyValue	back to summary
public V setKeyValue(final K key, final V value) Replaces the current key and value with the provided key & value.

setValue back to summary

setValue	back to summary
public V setValue(final V value) Implements java.util.Map.Entry.setValue. Doc from java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's `remove` operation). Parameters value:V new value to be stored in this entry Returns:V old value corresponding to the entry Annotations @Override

public V setValue(final V value)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters

value:V: new value to be stored in this entry

Returns:V

old value corresponding to the entry

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class AbstractBitwiseTrie<K, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class AbstractBitwiseTrie.BasicEntry<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail