com.generationjava.collections
Class AliasedMap

java.lang.Object
  |
  +--com.generationjava.collections.AliasedMap

All Implemented Interfaces:

java.util.Map

public class AliasedMap

extends java.lang.Object

implements java.util.Map

A Map in which some key's values may point to another key. A process coined as 'aliasing'.

Constructor Summary

AliasedMap()

AliasedMap(java.util.Map m)

Method Summary

void	alias(java.lang.Object aliaskey, java.lang.Object existingkey) Alias an existing key with an aliased key.
java.util.Collection	aliases() Get all aliases.
void	clear() Removes all mappings from this map.
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.util.Set	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(java.lang.Object o) Compares the specified object with this map for equality.
java.lang.Object	get(java.lang.Object key) Returns the value to which this map maps the specified key.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set	keySet() Returns a set view of the keys contained in this map.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Associates the specified value with the specified key in this map .
void	putAll(java.util.Map t) Copies all of the mappings from the specified map to this map.
java.lang.Object	remove(java.lang.Object key) Removes the mapping for this key from this map if present.
int	size() Returns the number of key-value mappings in this map.
java.util.Collection	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasedMap

public AliasedMap(java.util.Map m)

AliasedMap

public AliasedMap()

Method Detail

alias

public void alias(java.lang.Object aliaskey,
                  java.lang.Object existingkey)

Alias an existing key with an aliased key. The existing key may be an alias.

Parameters:

aliaskey - Object new alias

existingkey - Object existing key

aliases

public java.util.Collection aliases()

Get all aliases.

clear

public void clear()

Removes all mappings from this map.

Specified by:

clear in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface java.util.Map

entrySet

public java.util.Set entrySet()

Returns a set view of the mappings contained in this map.

Specified by:

entrySet in interface java.util.Map

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this map for equality.

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

get

public java.lang.Object get(java.lang.Object key)

Returns the value to which this map maps the specified key.

Specified by:

get in interface java.util.Map

hashCode

public int hashCode()

Returns the hash code value for this map.

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface java.util.Map

keySet

public java.util.Set keySet()

Returns a set view of the keys contained in this map.

Specified by:

keySet in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Associates the specified value with the specified key in this map .

Specified by:

put in interface java.util.Map

putAll

public void putAll(java.util.Map t)

Copies all of the mappings from the specified map to this map.

Specified by:

putAll in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Removes the mapping for this key from this map if present.

Specified by:

remove in interface java.util.Map

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface java.util.Map

values

public java.util.Collection values()

Returns a collection view of the values contained in this map.

Specified by:

values in interface java.util.Map