org.key_project.util.collection

Class DefaultImmutableMap<S,T>

java.lang.Object

org.key_project.util.collection.DefaultImmutableMap<S,T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<ImmutableMapEntry<S,T>>, ImmutableMap<S,T>

Direct Known Subclasses:

DefaultImmutableMap.NILMap

public class DefaultImmutableMap<S,T>
extends java.lang.Object
implements ImmutableMap<S,T>

This class implements ImmMap and provides a persistent Map. It is a simple implementation like lists

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultImmutableMap.MapEntry<S,T> inner class for the entries
private static class	DefaultImmutableMap.MapEntryIterator<S,T> iterator for the values
private static class	DefaultImmutableMap.MapIterator<S,T> iterator for the values
private static class	DefaultImmutableMap.MapKeyIterator<S,T>
private static class	DefaultImmutableMap.MapValueIterator<S,T>
private static class	DefaultImmutableMap.NILMap<S,T> the empty map

Field Summary

Fields

Modifier and Type	Field and Description
private ImmutableMapEntry<S,T>	entry list of pairs (key,value)
private DefaultImmutableMap<S,T>	parent
private static long	serialVersionUID generated serial
private int	size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultImmutableMap() only for use by NILMap
protected	DefaultImmutableMap(ImmutableMapEntry<S,T> entry) creates new map with mapping entry
protected	DefaultImmutableMap(ImmutableMapEntry<S,T> entry, DefaultImmutableMap<S,T> parent) creates new map with mapping entry and parent map

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(S key)
boolean	containsValue(T value)
private DefaultImmutableMap<S,T>	createMap(ImmutableMapEntry<S,T>[] stack, int counter, DefaultImmutableMap<S,T> p_parent)
boolean	equals(java.lang.Object o)
T	get(S key)
int	hashCode()
boolean	isEmpty() returns true if the map is empty
java.util.Iterator<ImmutableMapEntry<S,T>>	iterator()
java.util.Iterator<S>	keyIterator()
static <S,T> DefaultImmutableMap<S,T>	nilMap() the empty map
ImmutableMap<S,T>	put(S key, T value) inserts mapping into the map (old map is not modified) if key exists old entry has to be removed null is not allowed for key or value.
DefaultImmutableMap<S,T>	remove(S key) removes mapping (key,...) from map
ImmutableMap<S,T>	removeAll(T value) removes all mappings (...
int	size()
java.lang.String	toString()
java.util.Iterator<T>	valueIterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

serialVersionUID

private static final long serialVersionUID

generated serial

See Also:

Constant Field Values

parent

private final DefaultImmutableMap<S,T> parent

entry

private final ImmutableMapEntry<S,T> entry

list of pairs (key,value)

size

private final int size

Constructor Detail

DefaultImmutableMap

protected DefaultImmutableMap()

only for use by NILMap

DefaultImmutableMap

protected DefaultImmutableMap(ImmutableMapEntry<S,T> entry)

creates new map with mapping entry

DefaultImmutableMap

protected DefaultImmutableMap(ImmutableMapEntry<S,T> entry,
                              DefaultImmutableMap<S,T> parent)

creates new map with mapping entry and parent map

Method Detail

nilMap

public static <S,T> DefaultImmutableMap<S,T> nilMap()

the empty map

put

public ImmutableMap<S,T> put(S key,
                             T value)

inserts mapping into the map (old map is not modified) if key exists old entry has to be removed null is not allowed for key or value.

Specified by:

put in interface ImmutableMap<S,T>

Parameters:

key - a S to be used as key

value - a T to be stored as value

Returns:

a ImmMap including the pair and all other pairs of the current map with keys different from the given key

get

public T get(S key)

Specified by:

get in interface ImmutableMap<S,T>

Returns:

value of type T that is mapped by key of type S

size

public int size()

Specified by:

size in interface ImmutableMap<S,T>

Returns:

number of entries as int

isEmpty

public boolean isEmpty()

returns true if the map is empty

Specified by:

isEmpty in interface ImmutableMap<S,T>

Returns:

true iff the map is empty

containsKey

public boolean containsKey(S key)

Specified by:

containsKey in interface ImmutableMap<S,T>

Returns:

true iff the map includes key

containsValue

public boolean containsValue(T value)

Specified by:

containsValue in interface ImmutableMap<S,T>

Returns:

true iff the map includes value

createMap

private DefaultImmutableMap<S,T> createMap(ImmutableMapEntry<S,T>[] stack,
                                           int counter,
                                           DefaultImmutableMap<S,T> p_parent)

remove

public DefaultImmutableMap<S,T> remove(S key)

removes mapping (key,...) from map

Specified by:

remove in interface ImmutableMap<S,T>

Returns:

the new map (the same if key is not in the map)

removeAll

public ImmutableMap<S,T> removeAll(T value)

removes all mappings (...,value) from map

Specified by:

removeAll in interface ImmutableMap<S,T>

Returns:

the new map (the same if value is not mapped)

keyIterator

public java.util.Iterator<S> keyIterator()

Specified by:

keyIterator in interface ImmutableMap<S,T>

Returns:

iterator for all keys

valueIterator

public java.util.Iterator<T> valueIterator()

Specified by:

valueIterator in interface ImmutableMap<S,T>

Returns:

iterator for all values

iterator

public java.util.Iterator<ImmutableMapEntry<S,T>> iterator()

Specified by:

iterator in interface java.lang.Iterable<ImmutableMapEntry<S,T>>

Specified by:

iterator in interface ImmutableMap<S,T>

Returns:

iterator for entries

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object