Package joptsimple.internal

Class AbbreviationMap<V>

java.lang.Object

joptsimple.internal.AbbreviationMap<V>

Type Parameters:

V - a constraint on the types of the values in the map

All Implemented Interfaces:

OptionNameMap<V>

public class AbbreviationMap<V>
extends Object
implements OptionNameMap<V>

A map whose keys are strings; when a key/value pair is added to the map, the longest unique abbreviations of that key are added as well, and associated with the value. Thus:

   
   abbreviations.put( "good", "bye" );
   
 

would make it such that you could retrieve the value "bye" from the map using the keys "good", "goo", "go", and "g". A subsequent invocation of:

   
   abbreviations.put( "go", "fish" );
   
 

would make it such that you could retrieve the value "bye" using the keys "good" and "goo", and the value "fish" using the key "go". The key "g" would yield null, since it would no longer be a unique abbreviation.

The data structure is much like a "trie".

Author:

Paul Holser

See Also:

Perl's Text::Abbrev module, Radix tree

Constructor Summary

Constructors

Constructor	Description
AbbreviationMap()

Method Summary

Modifier and Type	Method	Description
boolean	contains(String key)	Tells whether the given key is in the map, or whether the given key is a unique abbreviation of a key that is in the map.
V	get(String key)	Answers the value associated with the given key.
void	put(String key, V newValue)	Associates a given value with a given key.
void	putAll(Iterable<String> keys, V newValue)	Associates a given value with a given set of keys.
void	remove(String key)	If the map contains the given key, dissociates the key from its value.
Map<String,V>	toJavaUtilMap()	Gives a Java map representation of this abbreviation map.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbbreviationMap

public AbbreviationMap()

Method Detail

contains

public boolean contains(String key)

Tells whether the given key is in the map, or whether the given key is a unique abbreviation of a key that is in the map.

Specified by:

contains in interface OptionNameMap<V>

Parameters:

key - key to look up

Returns:

true if key is present in the map

Throws:

NullPointerException - if key is null

get

public V get(String key)

Answers the value associated with the given key. The key can be a unique abbreviation of a key that is in the map.

Specified by:

get in interface OptionNameMap<V>

Parameters:

key - key to look up

Returns:

the value associated with aKey; or null if there is no such value or aKey is not a unique abbreviation of a key in the map

Throws:

NullPointerException - if aKey is null

put

public void put(String key,
                V newValue)

Associates a given value with a given key. If there was a previous association, the old value is replaced with the new one.

Specified by:

put in interface OptionNameMap<V>

Parameters:

key - key to create in the map

newValue - value to associate with the key

Throws:

NullPointerException - if aKey or newValue is null

IllegalArgumentException - if aKey is a zero-length string

putAll

public void putAll(Iterable<String> keys,
                   V newValue)

Associates a given value with a given set of keys. If there was a previous association, the old value is replaced with the new one.

Specified by:

putAll in interface OptionNameMap<V>

Parameters:

keys - keys to create in the map

newValue - value to associate with the key

Throws:

NullPointerException - if keys or newValue is null

IllegalArgumentException - if any of keys is a zero-length string

remove

public void remove(String key)

If the map contains the given key, dissociates the key from its value.

Specified by:

remove in interface OptionNameMap<V>

Parameters:

key - key to remove

Throws:

NullPointerException - if aKey is null

IllegalArgumentException - if aKey is a zero-length string

toJavaUtilMap

public Map<String,V> toJavaUtilMap()

Gives a Java map representation of this abbreviation map.

Specified by:

toJavaUtilMap in interface OptionNameMap<V>

Returns:

a Java map corresponding to this abbreviation map