Package org.dom4j
Class Namespace
java.lang.Object
org.dom4j.tree.AbstractNode
org.dom4j.Namespace
- All Implemented Interfaces:
Serializable
,Cloneable
,Node
- Direct Known Subclasses:
DefaultNamespace
Namespace
is a Flyweight Namespace that can be shared amongst
nodes.- Version:
- $Revision: 1.22 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final NamespaceCache
Cache of Namespace instancesprivate int
A cached version of the hashcode for efficiencystatic final Namespace
No Namespace presentprivate String
The prefix mapped to this namespaceprivate String
The URI for this namespacestatic final Namespace
XML NamespaceFields inherited from class org.dom4j.tree.AbstractNode
NODE_TYPE_NAMES
Fields inherited from interface org.dom4j.Node
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
is the method used in the Visitor Pattern.asXML()
asXML
returns the textual XML representation of this node.protected int
Factory method to create the hashcode allowing derived classes to change the behaviourprotected Node
createXPathResult
(Element parent) boolean
Checks whether this Namespace equals the given Namespace.static Namespace
A helper method to return the Namespace instance for no prefix and the URIstatic Namespace
A helper method to return the Namespace instance for the given prefix and URIshort
Returns the code according to the type of node.Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.DOCUMENT ME!Returns the XPath string-value of this node.getText()
Returns the text of this node.getUniquePath
(Element context) Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node.getURI()
DOCUMENT ME!int
hashCode()
DOCUMENT ME!toString()
Methods inherited from class org.dom4j.tree.AbstractNode
asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getName, getNodeTypeName, getParent, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write
-
Field Details
-
CACHE
Cache of Namespace instances -
XML_NAMESPACE
XML Namespace -
NO_NAMESPACE
No Namespace present -
prefix
The prefix mapped to this namespace -
uri
The URI for this namespace -
hashCode
private int hashCodeA cached version of the hashcode for efficiency
-
-
Constructor Details
-
Namespace
DOCUMENT ME!- Parameters:
prefix
- is the prefix for this namespaceuri
- is the URI for this namespace
-
-
Method Details
-
get
A helper method to return the Namespace instance for the given prefix and URI- Parameters:
prefix
- DOCUMENT ME!uri
- DOCUMENT ME!- Returns:
- an interned Namespace object
-
get
A helper method to return the Namespace instance for no prefix and the URI- Parameters:
uri
- DOCUMENT ME!- Returns:
- an interned Namespace object
-
getNodeType
public short getNodeType()Description copied from interface:Node
Returns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.- Specified by:
getNodeType
in interfaceNode
- Overrides:
getNodeType
in classAbstractNode
- Returns:
- a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE
-
hashCode
public int hashCode()DOCUMENT ME! -
createHashCode
protected int createHashCode()Factory method to create the hashcode allowing derived classes to change the behaviour- Returns:
- DOCUMENT ME!
-
equals
Checks whether this Namespace equals the given Namespace. Two Namespaces are equals if their URI and prefix are equal. -
getText
Description copied from interface:Node
Returns the text of this node.
- Specified by:
getText
in interfaceNode
- Overrides:
getText
in classAbstractNode
- Returns:
- the text for this node.
-
getStringValue
Description copied from interface:Node
Returns the XPath string-value of this node. The behaviour of this method is defined in the XPath specification .- Specified by:
getStringValue
in interfaceNode
- Overrides:
getStringValue
in classAbstractNode
- Returns:
- the text from all the child Text and Element nodes appended together.
-
getPrefix
DOCUMENT ME!- Returns:
- the prefix for this
Namespace
.
-
getURI
DOCUMENT ME!- Returns:
- the URI for this
Namespace
.
-
getXPathNameStep
-
getPath
Description copied from interface:Node
Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. No indexing will be used to restrict the path if multiple elements with the same name occur on the path.- Parameters:
context
- is the parent context from which the relative path should start. If the context is null or the context is not an ancestor of this node then the path will be absolute and start from the document and so begin with the '/' character.- Returns:
- the XPath expression relative to the given context which will return a nodeset containing at least this node.
-
getUniquePath
Description copied from interface:Node
Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.
- Parameters:
context
- is the parent context from which the path should start. If the context is null or the context is not an ancestor of this node then the path will start from the document and so begin with the '/' character.- Returns:
- the XPath expression relative to the given context which will return a nodeset containing just this node.
-
toString
-
asXML
Description copied from interface:Node
asXML
returns the textual XML representation of this node.- Returns:
- the XML representation of this node
-
accept
Description copied from interface:Node
accept
is the method used in the Visitor Pattern.- Parameters:
visitor
- is the visitor in the Visitor Pattern
-
createXPathResult
- Overrides:
createXPathResult
in classAbstractNode
-