craterdog.collections

Class Dictionary<V>

java.lang.Object

craterdog.smart.SmartObject<Sequence<E>>

craterdog.collections.abstractions.Sequence<E>

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OpenCollection<E>

craterdog.collections.abstractions.SortableCollection<Association<K,V>>

craterdog.collections.Map<java.lang.String,V>

craterdog.collections.Dictionary<V>

Type Parameters:

V - The type of the value in the association.

All Implemented Interfaces:

craterdog.core.Composite, craterdog.core.Sequential<Association<java.lang.String,V>>, java.lang.Comparable<Sequence<Association<java.lang.String,V>>>, java.lang.Iterable<Association<java.lang.String,V>>

public final class Dictionary<V>
extends Map<java.lang.String,V>

This collection class is a convenience class that implements a Map whose keys are always of type String. The implementation dynamically scales up and down the size of the underlying data structures as the number elements changes over time.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
Dictionary() This constructor creates a new empty dictionary.
Dictionary(Collection<java.lang.String> keys, Collection<V> values) This constructor creates a new dictionary using the specified keys and values.
Dictionary(Map<java.lang.String,V> elements) This constructor creates a new dictionary using the elements provided in the specified map.
Dictionary(java.util.Map<java.lang.String,V> elements) This constructor creates a new dictionary using the elements provided in a java map.
Dictionary(java.lang.String[] keys, V[] values) This constructor creates a new dictionary using the specified key and value arrays.

Method Summary

Modifier and Type	Method and Description
static <V> Dictionary<V>	concatenation(Dictionary<V> dictionary1, Dictionary<V> dictionary2) This function returns a new dictionary that contains the all the associations from both the specified dictionaries.
Dictionary<V>	copy()
static <V> Dictionary<V>	reduction(Dictionary<V> dictionary, Set<java.lang.String> keys) This function returns a new dictionary that contains only the associations with the specified keys.

Methods inherited from class craterdog.collections.Map

addElement, concatenation, containsElement, createIterator, createManipulator, getAssociations, getElement, getElements, getIndex, getKeys, getSize, getValue, getValues, reduction, removeAll, removeElement, removeValue, setValue, toMap

Methods inherited from class craterdog.collections.abstractions.SortableCollection

concatenate, shuffleElements, sortElements, sortElements, sortElements

Methods inherited from class craterdog.collections.abstractions.OpenCollection

addElements, addElements, removeElements, removeElements

Methods inherited from class craterdog.collections.abstractions.Collection

containsAll, containsAny, normalizedIndex

Methods inherited from class craterdog.collections.abstractions.Sequence

compareTo, equals, hashCode, toArray

Methods inherited from class craterdog.smart.SmartObject

addSerializableClass, addSerializableClass, addSerializableClass, createMapper, fromString, fromString, toExposedString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.core.Sequential

isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Dictionary

public Dictionary()

This constructor creates a new empty dictionary.

Dictionary

public Dictionary(java.lang.String[] keys,
                  V[] values)

This constructor creates a new dictionary using the specified key and value arrays. The number of keys must equal the number of values or an exception is thrown.

Parameters:

keys - The array of keys that should be used to create the dictionary.

values - The array of values that should be used to create the dictionary.

Dictionary

public Dictionary(Collection<java.lang.String> keys,
                  Collection<V> values)

This constructor creates a new dictionary using the specified keys and values. The number of keys must equal the number of values or an exception is thrown.

Parameters:

keys - The keys that should be used to create the dictionary.

values - The values that should be used to create the dictionary.

Dictionary

public Dictionary(Map<java.lang.String,V> elements)

This constructor creates a new dictionary using the elements provided in the specified map.

Parameters:

elements - The dictionary containing the key-value pairs to be mapped.

Dictionary

public Dictionary(java.util.Map<java.lang.String,V> elements)

This constructor creates a new dictionary using the elements provided in a java map.

Parameters:

elements - The java map containing the key-value pairs to be mapped.

Method Detail

copy

public Dictionary<V> copy()

Overrides:

copy in class Map<java.lang.String,V>

concatenation

public static <V> Dictionary<V> concatenation(Dictionary<V> dictionary1,
                                              Dictionary<V> dictionary2)

This function returns a new dictionary that contains the all the associations from both the specified dictionaries.

Type Parameters:

V - The type of value contained in the dictionaries.

Parameters:

dictionary1 - The first dictionary whose elements are to be added.

dictionary2 - The second dictionary whose elements are to be added.

Returns:

The resulting dictionary.

reduction

public static <V> Dictionary<V> reduction(Dictionary<V> dictionary,
                                          Set<java.lang.String> keys)

This function returns a new dictionary that contains only the associations with the specified keys.

Type Parameters:

V - The type of value contained in the dictionaries.

Parameters:

dictionary - The dictionary whose elements are to be reduced.

keys - The set of keys for the associates to be saved.

Returns:

The resulting dictionary.