|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.opensaml.xml.util.IDIndex
@NotThreadSafe public class IDIndex
Class which provides storage for the ID-to-XMLObject index mapping on an owning XMLObject
.
Constructor Summary | |
---|---|
IDIndex(XMLObject newOwner)
Constructor. |
Method Summary | |
---|---|
void |
deregisterIDMapping(String id)
Deregister an ID-to-XMLObject mapping for one of this object's owner's children. |
void |
deregisterIDMappings(IDIndex idIndex)
Deregister multiple ID-to-XMLObject mappings for this object's owner's children. |
protected Map<String,XMLObject> |
getIDMappings()
Get the ID-to-XMLObject mappings for this object's object's owner's children. |
Set<String> |
getIDs()
Get the set of ID strings which are the index keys. |
boolean |
isEmpty()
Return whether the index is currently empty. |
XMLObject |
lookup(String id)
Lookup and return the XMLObject identified by the specified ID attribute. |
void |
registerIDMapping(String id,
XMLObject referent)
Register an ID-to-XMLObject mapping for one of this object's owner's children. |
void |
registerIDMappings(IDIndex idIndex)
Register multiple ID-to-XMLObject mappings for this object's owner's children. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IDIndex(XMLObject newOwner) throws NullPointerException
newOwner
- the XMLObject which owns this ID-to-XMLObject index
NullPointerException
- thrown if the given XMLObject is nullMethod Detail |
---|
public void registerIDMapping(String id, XMLObject referent)
id
- the XMLObject child's ID attribute valuereferent
- the XMLObject childpublic void registerIDMappings(IDIndex idIndex)
idIndex
- the ID-to-XMLObject mapping to registerpublic void deregisterIDMapping(String id)
id
- the ID attribute value of the XMLObject child to deregisterpublic void deregisterIDMappings(IDIndex idIndex)
idIndex
- the ID-to-XMLObject mappings to deregisterpublic XMLObject lookup(String id)
id
- the ID attribute value to lookup
public boolean isEmpty()
public Set<String> getIDs()
protected Map<String,XMLObject> getIDMappings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |