|
XMLTooling-J 1.3.2-redhat-4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.xml.NamespaceManager
public class NamespaceManager
A class which is responsible for managing XML namespace-related data for an XMLObject
.
Code which mutates the state of an XMLObject such that XML namespace-related data is also logically changed, should call the appropriate method, based on the type of change being made.
Field Summary | |
---|---|
static String |
DEFAULT_NS_TOKEN
The token used to represent the default namespace in getNonVisibleNamespacePrefixes() . |
Constructor Summary | |
---|---|
NamespaceManager(XMLObject owningObject)
Constructor. |
Method Summary | |
---|---|
void |
deregisterAttributeName(QName attributeName)
Deregister a namespace-qualified attribute name. |
void |
deregisterAttributeValue(String attributeID)
Deregister a QName attribute value. |
void |
deregisterContentValue()
Deregister a QName content value. |
void |
deregisterNamespace(Namespace namespace)
Deregister usage of a namespace in some indeterminate fashion. |
void |
deregisterNamespaceDeclaration(Namespace namespace)
Deregister a namespace declaration. |
static String |
generateAttributeID(QName name)
From an QName representing a qualified attribute name, generate an attribute ID suitable for use in registerAttributeValue(String, QName)
and deregisterAttributeValue(String) . |
Set<Namespace> |
getAllNamespacesInSubtreeScope()
Get the set of all namespaces which are in scope within the subtree rooted at the owning XMLObject. |
Set<Namespace> |
getNamespaces()
Get the set of namespaces currently in use on the owning XMLObject. |
Set<String> |
getNonVisibleNamespacePrefixes()
Obtain the set of namespace prefixes used in a non-visible manner on owning XMLObject and its children. |
Set<Namespace> |
getNonVisibleNamespaces()
Obtain the set of namespaces used in a non-visible manner on owning XMLObject and its children. |
XMLObject |
getOwner()
Get the owning XMLObject instance. |
void |
registerAttributeName(QName attributeName)
Register a namespace-qualified attribute name. |
void |
registerAttributeValue(String attributeID,
QName attributeValue)
Register a QName attribute value. |
void |
registerContentValue(QName content)
Register a QName element content value. |
void |
registerElementName(QName name)
Register the owning XMLObject's element name. |
void |
registerElementType(QName type)
Register the owning XMLObject's element type, if explicitly declared via an xsi:type. |
void |
registerNamespace(Namespace namespace)
Register usage of a namespace in some indeterminate fashion. |
void |
registerNamespaceDeclaration(Namespace namespace)
Register a namespace declaration. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_NS_TOKEN
getNonVisibleNamespacePrefixes()
.
Constructor Detail |
---|
public NamespaceManager(XMLObject owningObject)
owningObject
- the XMLObject whose namespace info is to be managedMethod Detail |
---|
public static String generateAttributeID(QName name)
registerAttributeValue(String, QName)
and deregisterAttributeValue(String)
.
name
- attribute name as a QName
public XMLObject getOwner()
public Set<Namespace> getNamespaces()
public void registerNamespace(Namespace namespace)
Other methods which indicate specific usage should be preferred over this one. This
method exists primarily for backward-compatibility support for XMLObject.addNamespace(Namespace)
.
namespace
- namespace to registerpublic void deregisterNamespace(Namespace namespace)
Other methods which indicate specific usage should be preferred over this one. This
method exists primarily for backward-compatibility support for XMLObject.removeNamespace(Namespace)
.
namespace
- namespace to deregisterpublic void registerNamespaceDeclaration(Namespace namespace)
namespace
- the namespace to registerpublic void deregisterNamespaceDeclaration(Namespace namespace)
namespace
- the namespace to deregisterpublic void registerAttributeName(QName attributeName)
attributeName
- the attribute name to registerpublic void deregisterAttributeName(QName attributeName)
attributeName
- the attribute name to deregisterpublic void registerAttributeValue(String attributeID, QName attributeValue)
attributeID
- unique identifier for the attribute within the XMLObject's content modelattributeValue
- the QName value to registerpublic void deregisterAttributeValue(String attributeID)
attributeID
- unique identifier for the attribute within the XMLObject's content modelpublic void registerContentValue(QName content)
content
- the QName value to registerpublic void deregisterContentValue()
public Set<String> getNonVisibleNamespacePrefixes()
The primary use case for this information is to support the inclusive prefixes information that may optionally be supplied as a part of XML exclusive canonicalization.
public Set<Namespace> getNonVisibleNamespaces()
The primary use case for this information is to support the inclusive prefixes information that may optionally be supplied as a part of XML exclusive canonicalization.
The Namespace instances themselves will be copied before being returned, so
modifications to them do not affect the actual Namespace instances in the
underlying tree. The original alwaysDeclare
property is not preserved.
public Set<Namespace> getAllNamespacesInSubtreeScope()
The Namespace instances themselves will be copied before being returned, so
modifications to them do not affect the actual Namespace instances in the
underlying tree. The original alwaysDeclare
property is not preserved.
public void registerElementName(QName name)
name
- the element name to registerpublic void registerElementType(QName type)
type
- the element type to register
|
XMLTooling-J 1.3.2-redhat-4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |