Package org.jdom2
Class Namespace
java.lang.Object
org.jdom2.Namespace
- All Implemented Interfaces:
Serializable
An XML namespace representation, as well as a factory for creating XML
namespace objects. All methods on Namespace (including
getNamespace(String)
and getNamespace(String, String)
)
are thread-safe.
See NamespaceAware
for additional notes on how Namespaces are
'in-scope' in JDOM content, and how those in-scope Namespaces are accessed.
- Author:
- Brett McLaughlin, Elliotte Rusty Harold, Jason Hunter, Wesley Biggs, Rolf Lear
- See Also:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
This tests for equality - TwoNamespaces
are equal if and only if their URIs are byte-for-byte equals.static Namespace
getNamespace
(String uri) This will retrieve (if in existence) or create (if not) aNamespace
for the supplied URI, and make it usable as a default namespace, as no prefix is supplied.static Namespace
getNamespace
(String prefix, String uri) This will retrieve (if in existence) or create (if not) aNamespace
for the supplied prefix and uri.This returns the prefix mapped to thisNamespace
.getURI()
This returns the namespace URI for thisNamespace
.int
hashCode()
This returns the hash code for theNamespace
that conforms to the 'equals()' contract.toString()
This returns aString
representation of thisNamespace
, suitable for use in debugging.
-
Field Details
-
NO_NAMESPACE
Define aNamespace
for when not in a namespace -
XML_NAMESPACE
Define aNamespace
for the standard xml prefix.
-
-
Method Details
-
getNamespace
This will retrieve (if in existence) or create (if not) aNamespace
for the supplied prefix and uri. This method is thread-safe.- Parameters:
prefix
-String
prefix to map toNamespace
.uri
-String
URI of newNamespace
.- Returns:
Namespace
- ready to use namespace.- Throws:
IllegalNameException
- if the given prefix and uri make up an illegal namespace name.- See Also:
-
getNamespace
This will retrieve (if in existence) or create (if not) aNamespace
for the supplied URI, and make it usable as a default namespace, as no prefix is supplied. This method is thread-safe.- Parameters:
uri
-String
URI of newNamespace
.- Returns:
Namespace
- ready to use namespace.
-
getPrefix
This returns the prefix mapped to thisNamespace
.- Returns:
String
- prefix for thisNamespace
.
-
getURI
This returns the namespace URI for thisNamespace
.- Returns:
String
- URI for thisNamespace
.
-
equals
This tests for equality - TwoNamespaces
are equal if and only if their URIs are byte-for-byte equals. -
toString
This returns aString
representation of thisNamespace
, suitable for use in debugging. -
hashCode
public int hashCode()This returns the hash code for theNamespace
that conforms to the 'equals()' contract.If two namespaces have the same URI, they are equal and have the same hash code, even if they have different prefixes.
-