|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.torque.generator.qname.QualifiedNameMap<T>
T
- The class of the object which should be stored in the map.public class QualifiedNameMap<T>
A special map with a QualifiedName as a key. This map acts as a normal map,
except that it has an additional method, getInNamespace()
,
which respects the visibility rules in the namespace hierarchy. Null cannot
be stored as a key for this map.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
QualifiedNameMap()
Constructs an empty QualifiedNameMap. |
|
QualifiedNameMap(Map<? extends QualifiedName,? extends T> map)
Constructs a shallow copy of the supplied map. |
Method Summary | |
---|---|
void |
clear()
Removes all mappings from this map. |
boolean |
containsKey(Object key)
Returns if this Map contains a mapping for the given key. |
boolean |
containsValue(Object value)
Checks if any key is mapped to the given value. |
Set<Map.Entry<QualifiedName,T>> |
entrySet()
Returns all Entries in this map. |
boolean |
equals(Object object)
Checks if this QualifiedNameMap is equal to another object. |
T |
get(Object key)
Returns the object which is mapped to the given key. |
QualifiedNameMap<T> |
getAllInHierarchy(Namespace namespace)
Returns all mappings which live in the given namespace. |
QualifiedNameMap<T> |
getInHierarchy(Namespace namespace)
Returns all mappings which live in the given namespace. |
T |
getInHierarchy(QualifiedName key)
Returns the most specific entry in the map which is visible for the provided key. |
QualifiedName |
getKeyInHierarchy(QualifiedName key)
Returns the most specific key in the map which is visible for the provided key. |
T |
getMoreSpecific(T object1,
QualifiedName qualifiedName1,
T object2,
QualifiedName qualifiedName2)
Returns the more specific object out of two objects (the object which hides the other object). |
int |
hashCode()
Returns a hashCode for this object. |
boolean |
isEmpty()
Returns if the map contains any mappings at all. |
Set<QualifiedName> |
keySet()
Returns all keys of the map. |
T |
put(QualifiedName key,
T value)
Creates or overwrites a mapping in the map. |
void |
putAll(Map<? extends QualifiedName,? extends T> toPut)
Creates or overrides mappings for all the mappings in the supplied map. |
T |
remove(Object key)
Removes the mapping for the supplied key, if this mapping exists. |
int |
size()
Counts all mappings in the map. |
String |
toString()
Returns a string representation of this map for debugging purposes. |
Collection<T> |
values()
Returns all values in this map. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public QualifiedNameMap()
public QualifiedNameMap(Map<? extends QualifiedName,? extends T> map)
map
- the map to copy, not null.Method Detail |
---|
public T getInHierarchy(QualifiedName key)
get(Object)
method.
key
- the qualified name for which the entries in the map should
be searched, not null.
NullPointerException
- if key is null.get(Object)
public QualifiedName getKeyInHierarchy(QualifiedName key)
key
- the qualified name for which the entries in the map should
be searched, not null.
NullPointerException
- if key is null.public QualifiedNameMap<T> getAllInHierarchy(Namespace namespace)
namespace
- the namespace in which the desired objects
should be visible.
public QualifiedNameMap<T> getInHierarchy(Namespace namespace)
namespace
- the namespace in which the desired objects
should be visible.
public T get(Object key)
get
in interface Map<QualifiedName,T>
key
- the key for which the mapped object should be returned.
Map.get(java.lang.Object)
,
getInHierarchy(QualifiedName)
public T put(QualifiedName key, T value)
put
in interface Map<QualifiedName,T>
key
- the key for the mapping, not null.value
- the object mapped to the key.
Map.put(Object, Object)
public void putAll(Map<? extends QualifiedName,? extends T> toPut)
null
.
putAll
in interface Map<QualifiedName,T>
toPut
- the Map whcih mappings should be added to this map,
not null.
NullPointerException
- if toPut is null.
IllegalArgumentException
- if toPut contains a mapping for
the key null
.Map.putAll(java.util.Map)
public T remove(Object key)
remove
in interface Map<QualifiedName,T>
key
- the key for which the mapping should be removed.
Map.remove(java.lang.Object)
public void clear()
clear
in interface Map<QualifiedName,T>
Map.clear()
public boolean containsKey(Object key)
containsKey
in interface Map<QualifiedName,T>
key
- the key for which the existence of a mapping should be
checked.
Map.containsKey(java.lang.Object)
public Set<Map.Entry<QualifiedName,T>> entrySet()
entrySet
in interface Map<QualifiedName,T>
Map.entrySet()
public boolean containsValue(Object value)
containsValue
in interface Map<QualifiedName,T>
value
- the value which existence should be checked in the map.
Map.containsValue(java.lang.Object)
public Collection<T> values()
values
in interface Map<QualifiedName,T>
Map.values()
public int size()
size
in interface Map<QualifiedName,T>
Map.size()
public boolean isEmpty()
isEmpty
in interface Map<QualifiedName,T>
Map.isEmpty()
public Set<QualifiedName> keySet()
keySet
in interface Map<QualifiedName,T>
Map.keySet()
public T getMoreSpecific(T object1, QualifiedName qualifiedName1, T object2, QualifiedName qualifiedName2)
object1
- the first object to compare.qualifiedName1
- the qualified name of the first object,
must not be null if object1 is not null.object2
- the second object to compare.qualifiedName2
- the namepsace of the second object,
must not be null, if object2 is not null.
NullPointerException
- if object1 and object2 are not null and
namespace1 or namespace2 are null.public boolean equals(Object object)
equals
in interface Map<QualifiedName,T>
equals
in class Object
object
- the object to check whether it is equal to this object.
public int hashCode()
hashCode
in interface Map<QualifiedName,T>
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |