Package org.exolab.castor.xml
Class Namespaces
java.lang.Object
org.exolab.castor.xml.Namespaces
A class for handling Namespace declaration and scoping
- Version:
- $Revision$ $Date: 2004-09-09 23:04:08 -0600 (Thu, 09 Sep 2004) $
- Author:
- Keith Visco
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addNamespace
(String prefix, String uri) Adds the given namespace declaration to this Namespaces instancevoid
Declare the namespaces of this stack in as attributes.Returns all namespace prefixes declared locallyReturns an Enumeration of local namespace URIs for this Namespaces.getNamespacePrefix
(String nsURI) Returns the Namespace prefix associated with the given URI.String[]
getNamespacePrefixes
(String nsURI) Returns the Namespace prefixes associated with the given URI.getNamespaceURI
(String prefix) Returns the Namespace URI associated with the given prefixReturns the Namespace prefix associated with the given URI.boolean
removeNamespace
(String prefix) Removes the namespace declaration for the given prefix.void
sendEndEvents
(ContentHandler handler) Calls the given ContentHandler's endPrefixMapping method for each locally declared namespacevoid
sendStartEvents
(ContentHandler handler) Calls the given ContentHandler's startPrefixMapping method for each locally declared namespace
-
Field Details
-
XML_NAMESPACE_PREFIX
-
XML_NAMESPACE
-
-
Constructor Details
-
Namespaces
public Namespaces()
-
-
Method Details
-
addNamespace
Adds the given namespace declaration to this Namespaces instance- Parameters:
prefix
- the namespace prefixuri
- the namespace URI to be associated with the given prefix- Throws:
IllegalArgumentException
- if uri is null
-
getLocalNamespaces
Returns an Enumeration of local namespace URIs for this Namespaces.- Returns:
- an Enumeration of local namespace URIs.
-
getNamespaceURI
-
getNamespacePrefix
Returns the Namespace prefix associated with the given URI. If multiple namespace prefixes have been declared, then the first one found is returned. To obtain all prefixes see#getNamespacePrefixes
.- Parameters:
nsURI
- the namespace URI to lookup- Returns:
- the namespace prefix associated with the given URI
- Throws:
IllegalArgumentException
- if nsURI is null
-
getLocalNamespacePrefixes
Returns all namespace prefixes declared locally- Returns:
- an Enumeration of locally declared namespace prefixes
-
getNamespacePrefixes
Returns the Namespace prefixes associated with the given URI.- Parameters:
nsURI
- the namespace URI to lookuplocal
- a boolean that when true indicates only the local scope is searched.- Returns:
- the namespace prefixes associated with the given URI
- Throws:
IllegalArgumentException
- if nsURI is null
-
getNonDefaultNamespacePrefix
Returns the Namespace prefix associated with the given URI. Or null if no prefix has been declared. This method will ignore the default namespace. This is useful when dealing with attributes that do not use the default namespace.- Parameters:
nsURI
- the namespace URI to lookup- Returns:
- the namespace prefix associated with the given URI
- Throws:
IllegalArgumentException
- if nsURI is null
-
removeNamespace
Removes the namespace declaration for the given prefix. This is a local action only, the namespace declaration will not be removed from any parent Namespaces object.- Parameters:
prefix
- the namespace prefix to remove the binding of- Returns:
- true if the namespace declaration was removed, otherwise false.
-
sendEndEvents
Calls the given ContentHandler's endPrefixMapping method for each locally declared namespace- Parameters:
handler
- the ContentHandler- Throws:
SAXException
-
sendStartEvents
Calls the given ContentHandler's startPrefixMapping method for each locally declared namespace- Parameters:
handler
- the ContentHandler- Throws:
SAXException
-
declareAsAttributes
Declare the namespaces of this stack in as attributes.- Parameters:
atts
- the Attribute List to fill in.
-