JOpt Simple 5.0.4 · joptsimple.internal.AbbreviationMap

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".

Field Summary

Modifier and Type	Field and Description
private final Map<Character, AbbreviationMap<V>>	children
private String	key
private int	keysBeyond
private V	value

Constructor Summary

Access	Constructor and Description
public	AbbreviationMap()

Method Summary

Modifier and Type	Method and Description
private boolean	add(char[] chars, V newValue, int offset, int length)
private void	addToMappings(Map<String, V> mappings)
private static char[]	charsOf(String aKey)
public boolean	Returns: `true` if `key` is present in the map contains(String key to look up key) Implements joptsimple.internal.OptionNameMap.contains. 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.
public V	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 get(String key to look up key) Implements joptsimple.internal.OptionNameMap.get. Answers the value associated with the given key.
public void	put(String key to create in the map key, V value to associate with the key newValue) Implements joptsimple.internal.OptionNameMap.put. Associates a given value with a given key.
public void	putAll(Iterable<String> keys to create in the map keys, V value to associate with the key newValue) Implements joptsimple.internal.OptionNameMap.putAll. Associates a given value with a given set of keys.
public void	remove(String key to remove key) Implements joptsimple.internal.OptionNameMap.remove. If the map contains the given key, dissociates the key from its value.
private boolean	remove(char[] aKey, int offset, int length)
private boolean	removeAtEndOfKey()
private void	setValueToThatOfOnlyChild()
public Map<String, V>	Returns: a Java map corresponding to this abbreviation map toJavaUtilMap() Implements joptsimple.internal.OptionNameMap.toJavaUtilMap. Gives a Java map representation of this abbreviation map.

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

Field Detail

children	back to summary
private final Map<Character, AbbreviationMap<V>> children

key	back to summary
private String key

keysBeyond	back to summary
private int keysBeyond

value	back to summary
private V value

Constructor Detail

AbbreviationMap	back to summary
public AbbreviationMap()

Method Detail

add	back to summary
private boolean add(char[] chars, V newValue, int offset, int length)

addToMappings	back to summary
private void addToMappings(Map<String, V> mappings)

charsOf	back to summary
private static char[] charsOf(String aKey)

contains back to summary

contains	back to summary
public boolean contains(String key) Implements joptsimple.internal.OptionNameMap.contains. 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. Parameters key:String key to look up Returns:boolean `true` if `key` is present in the map Annotations @Override Exceptions NullPointerException: if `key` is `null`

public boolean contains(String key)

Implements joptsimple.internal.OptionNameMap.contains.

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.

Parameters

key:String: key to look up

Returns:boolean

true if key is present in the map

Annotations

@Override

Exceptions

NullPointerException:: if key is null

get back to summary

get	back to summary
public V get(String key) Implements joptsimple.internal.OptionNameMap.get. Answers the value associated with the given key. The key can be a unique abbreviation of a key that is in the map. Parameters key:String key to look up Returns:V 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 Annotations @Override Exceptions NullPointerException: if `aKey` is `null`

public V get(String key)

Implements joptsimple.internal.OptionNameMap.get.

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

Parameters

key:String: key to look up

Returns:V

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

Annotations

@Override

Exceptions

NullPointerException:: if aKey is null

put back to summary

put	back to summary
public void put(String key, V newValue) Implements joptsimple.internal.OptionNameMap.put. Associates a given value with a given key. If there was a previous association, the old value is replaced with the new one. Parameters key:String key to create in the map newValue:V value to associate with the key Annotations @Override Exceptions NullPointerException: if `aKey` or `newValue` is `null` IllegalArgumentException: if `aKey` is a zero-length string

public void put(String key, V newValue)

Implements joptsimple.internal.OptionNameMap.put.

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

Parameters

key:String: key to create in the map
newValue:V: value to associate with the key

Annotations

@Override

Exceptions

NullPointerException:: if aKey or newValue is null
IllegalArgumentException:: if aKey is a zero-length string

putAll back to summary

putAll	back to summary
public void putAll(Iterable<String> keys, V newValue) Implements joptsimple.internal.OptionNameMap.putAll. 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. Parameters keys:Iterable<String> keys to create in the map newValue:V value to associate with the key Annotations @Override Exceptions NullPointerException: if `keys` or `newValue` is `null` IllegalArgumentException: if any of `keys` is a zero-length string

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

Implements joptsimple.internal.OptionNameMap.putAll.

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.

Parameters

keys:Iterable<String>: keys to create in the map
newValue:V: value to associate with the key

Annotations

@Override

Exceptions

NullPointerException:: if keys or newValue is null
IllegalArgumentException:: if any of keys is a zero-length string

remove back to summary

remove	back to summary
public void remove(String key) Implements joptsimple.internal.OptionNameMap.remove. If the map contains the given key, dissociates the key from its value. Parameters key:String key to remove Annotations @Override Exceptions NullPointerException: if `aKey` is `null` IllegalArgumentException: if `aKey` is a zero-length string

public void remove(String key)

Implements joptsimple.internal.OptionNameMap.remove.

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

Parameters

key:String: key to remove

Annotations

@Override

Exceptions

NullPointerException:: if aKey is null
IllegalArgumentException:: if aKey is a zero-length string

remove	back to summary
private boolean remove(char[] aKey, int offset, int length)

removeAtEndOfKey	back to summary
private boolean removeAtEndOfKey()

setValueToThatOfOnlyChild	back to summary
private void setValueToThatOfOnlyChild()

toJavaUtilMap	back to summary
public Map<String, V> toJavaUtilMap() Implements joptsimple.internal.OptionNameMap.toJavaUtilMap. Gives a Java map representation of this abbreviation map. Returns:Map<String, V> a Java map corresponding to this abbreviation map Annotations @Override

toJavaUtilMap

back to summary

public Map<String, V> toJavaUtilMap()

Implements joptsimple.internal.OptionNameMap.toJavaUtilMap.

Gives a Java map representation of this abbreviation map.

Returns:Map<String, V>

a Java map corresponding to this abbreviation map

Annotations

@Override

public Class AbbreviationMap<V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail