Module nl.basjes.collections.prefixmap

Package nl.basjes.collections.prefixmap

Class StringPrefixMap<V extends Serializable>

java.lang.Object

nl.basjes.collections.prefixmap.StringPrefixMap<V>

Type Parameters:

V - The type of the value that is to be stored.

All Implemented Interfaces:

Serializable, Map<String,V>, PrefixMap<V>

Direct Known Subclasses:

ASCIIPrefixMap

public class StringPrefixMap<V extends Serializable>
extends Object
implements PrefixMap<V>, Serializable

The StringPrefixMap is an implementation of PrefixMap where the assumption is that the stored prefixes can be any character in a String.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringPrefixMap.KryoSerializer

Nested classes/interfaces inherited from interface java.util.Map

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

Constructor Summary

Constructors

Constructor	Description
StringPrefixMap(boolean caseSensitive)

Method Summary

Modifier and Type	Method	Description
void	clear()	The prefixmap will be empty after this call returns.
static void	configureKryo(Object kryoInstance)	This is used to configure the provided Kryo instance if Kryo serialization is desired.
boolean	containsKey(Object key)
boolean	containsPrefix(String prefix)	Returns true if this map contains an exact mapping for the specified prefix.
boolean	containsValue(Object value)
Set<Map.Entry<String,V>>	entrySet()
V	get(String prefix)	Return the value of the exact matching prefix.
V	getLongestMatch(String input)	Return the value of the longest matching prefix.
V	getShortestMatch(String input)	Return the value of the shortest matching prefix.
Set<String>	keySet()
V	put(String prefix, V value)	Stored the specified value as the result for the specified prefix.
V	remove(String prefix)	Removes the mapping for a prefix if present.
int	size()
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface nl.basjes.collections.PrefixMap

get, isEmpty, putAll, remove

Constructor Detail

StringPrefixMap

public StringPrefixMap(boolean caseSensitive)

Method Detail

configureKryo

public static void configureKryo(Object kryoInstance)

This is used to configure the provided Kryo instance if Kryo serialization is desired. The expected type here is Object because otherwise the Kryo library becomes a mandatory dependency on any project that uses Yauaa.

Parameters:

kryoInstance - The instance of com.esotericsoftware.kryo.Kryo that needs to be configured.

containsPrefix

public boolean containsPrefix(String prefix)

Description copied from interface: PrefixMap

Returns true if this map contains an exact mapping for the specified prefix.

Note that implementations may be constructed to match either case sensitive or case insensitive.

Specified by:

containsPrefix in interface PrefixMap<V extends Serializable>

Parameters:

prefix - prefix whose presence in this prefixmap is to be checked

Returns:

true if this map contains an the exact mapping for the specified prefix.

put

public V put(String prefix,
             V value)

Description copied from interface: PrefixMap

Stored the specified value as the result for the specified prefix.

If for the specified prefix previously a value was present then the old value is replaced with the new value and the old value is returned.

Note that implementations may be constructed to store this value for either case sensitive or case insensitive matching during retrieval.

Specified by:

put in interface Map<String,V extends Serializable>

Specified by:

put in interface PrefixMap<V extends Serializable>

Parameters:

prefix - prefix with which the specified value is to be associated

value - value to be associated with the specified prefix

Returns:

the previous value of the specified prefix, or null if there was no mapping for prefix.

size

public int size()

Specified by:

size in interface Map<String,V extends Serializable>

Specified by:

size in interface PrefixMap<V extends Serializable>

Returns:

the number of prefix-value mappings in this prefixmap

clear

public void clear()

Description copied from interface: PrefixMap

The prefixmap will be empty after this call returns.

Specified by:

clear in interface Map<String,V extends Serializable>

Specified by:

clear in interface PrefixMap<V extends Serializable>

remove

public V remove(String prefix)

Description copied from interface: PrefixMap

Removes the mapping for a prefix if present.

Note that implementations may be constructed to remove either case sensitive (only this exact value) or case insensitive (all case variations).

Specified by:

remove in interface PrefixMap<V extends Serializable>

Parameters:

prefix - prefix whose mapping is to be removed from the prefixmap

Returns:

the previous value associated with prefix (may be null).

get

public V get(String prefix)

Description copied from interface: PrefixMap

Return the value of the exact matching prefix.

The value returned is the stored prefix for which is true: input.equals(prefix).

Note that implementations may be constructed to match either case sensitive or case insensitive.

Specified by:

get in interface PrefixMap<V extends Serializable>

Parameters:

prefix - The string for which we need value of the stored prefix

Returns:

The value, null if not found.

getShortestMatch

public V getShortestMatch(String input)

Description copied from interface: PrefixMap

Return the value of the shortest matching prefix.

The value returned is the shortest stored prefix for which is true: input.startsWith(prefix).

Note that implementations may be constructed to match either case sensitive or case insensitive.

Specified by:

getShortestMatch in interface PrefixMap<V extends Serializable>

Parameters:

input - The string for which we need value of the stored prefix

Returns:

The value, null if not found.

getLongestMatch

public V getLongestMatch(String input)

Description copied from interface: PrefixMap

Return the value of the longest matching prefix.

The value returned is the longest stored prefix for which is true: input.startsWith(prefix).

Note that implementations may be constructed to match either case sensitive or case insensitive.

Specified by:

getLongestMatch in interface PrefixMap<V extends Serializable>

Parameters:

input - The string for which we need value of the stored prefix

Returns:

The value, null if not found.

entrySet

public Set<Map.Entry<String,V>> entrySet()

Specified by:

entrySet in interface Map<String,V extends Serializable>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,V extends Serializable>

Specified by:

containsKey in interface PrefixMap<V extends Serializable>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,V extends Serializable>

Specified by:

containsValue in interface PrefixMap<V extends Serializable>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,V extends Serializable>

Specified by:

keySet in interface PrefixMap<V extends Serializable>

values

public Collection<V> values()

Specified by:

values in interface Map<String,V extends Serializable>

Specified by:

values in interface PrefixMap<V extends Serializable>