org.dom4j
Class Namespace

java.lang.Object
  extended by org.dom4j.tree.AbstractNode
      extended by org.dom4j.Namespace
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Node
Direct Known Subclasses:
DefaultNamespace

public class Namespace
extends AbstractNode

Namespace is a Flyweight Namespace that can be shared amongst nodes.

Version:
$Revision: 1.22 $
Author:
James Strachan
See Also:
Serialized Form

Field Summary
protected static NamespaceCache CACHE
          Cache of Namespace instances
static Namespace NO_NAMESPACE
          No Namespace present
static Namespace XML_NAMESPACE
          XML Namespace
 
Constructor Summary
Namespace(java.lang.String prefix, java.lang.String uri)
          DOCUMENT ME!
 
Method Summary
 void accept(Visitor visitor)
           accept is the method used in the Visitor Pattern.
 java.lang.String asXML()
           asXML returns the textual XML representation of this node.
protected  int createHashCode()
          Factory method to create the hashcode allowing derived classes to change the behaviour
protected  Node createXPathResult(Element parent)
           
 boolean equals(java.lang.Object object)
          Checks whether this Namespace equals the given Namespace.
static Namespace get(java.lang.String uri)
          A helper method to return the Namespace instance for no prefix and the URI
static Namespace get(java.lang.String prefix, java.lang.String uri)
          A helper method to return the Namespace instance for the given prefix and URI
 NodeType getNodeTypeEnum()
          Returns the type of this node as constant from NodeType enum.
 java.lang.String getPath(Element context)
          Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.
 java.lang.String getPrefix()
          DOCUMENT ME!
 java.lang.String getStringValue()
          Returns the XPath string-value of this node.
 java.lang.String getText()
           Returns the text of this node.
 java.lang.String 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.
 java.lang.String getURI()
          DOCUMENT ME!
 java.lang.String getXPathNameStep()
           
 int hashCode()
          DOCUMENT ME!
 java.lang.String toString()
           
 
Methods inherited from class org.dom4j.tree.AbstractNode
asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getName, getNodeType, getNodeTypeName, getParent, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, toString, valueOf, write
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CACHE

protected static final NamespaceCache CACHE
Cache of Namespace instances


XML_NAMESPACE

public static final Namespace XML_NAMESPACE
XML Namespace


NO_NAMESPACE

public static final Namespace NO_NAMESPACE
No Namespace present

Constructor Detail

Namespace

public Namespace(java.lang.String prefix,
                 java.lang.String uri)
DOCUMENT ME!

Parameters:
prefix - is the prefix for this namespace
uri - is the URI for this namespace
Method Detail

get

public static Namespace get(java.lang.String prefix,
                            java.lang.String uri)
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

public static Namespace get(java.lang.String uri)
A helper method to return the Namespace instance for no prefix and the URI

Parameters:
uri - DOCUMENT ME!
Returns:
an interned Namespace object

getNodeTypeEnum

public NodeType getNodeTypeEnum()
Description copied from interface: Node
Returns the type of this node as constant from NodeType enum.

Specified by:
getNodeTypeEnum in interface Node
Overrides:
getNodeTypeEnum in class AbstractNode
Returns:
the type of this node

hashCode

public int hashCode()
DOCUMENT ME!

Overrides:
hashCode in class java.lang.Object
Returns:
the hash code based on the qualified name and the URI of the namespace.

createHashCode

protected int createHashCode()
Factory method to create the hashcode allowing derived classes to change the behaviour

Returns:
DOCUMENT ME!

equals

public boolean equals(java.lang.Object object)
Checks whether this Namespace equals the given Namespace. Two Namespaces are equals if their URI and prefix are equal.

Overrides:
equals in class java.lang.Object
Parameters:
object - DOCUMENT ME!
Returns:
DOCUMENT ME!

getText

public java.lang.String getText()
Description copied from interface: Node

Returns the text of this node.

Specified by:
getText in interface Node
Overrides:
getText in class AbstractNode
Returns:
the text for this node.

getStringValue

public java.lang.String 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 interface Node
Overrides:
getStringValue in class AbstractNode
Returns:
the text from all the child Text and Element nodes appended together.

getPrefix

public java.lang.String getPrefix()
DOCUMENT ME!

Returns:
the prefix for this Namespace.

getURI

public java.lang.String getURI()
DOCUMENT ME!

Returns:
the URI for this Namespace.

getXPathNameStep

public java.lang.String getXPathNameStep()

getPath

public java.lang.String getPath(Element context)
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

public java.lang.String getUniquePath(Element context)
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

public java.lang.String toString()
Overrides:
toString in class AbstractNode

asXML

public java.lang.String asXML()
Description copied from interface: Node

asXML returns the textual XML representation of this node.

Returns:
the XML representation of this node

accept

public void accept(Visitor visitor)
Description copied from interface: Node

accept is the method used in the Visitor Pattern.

Parameters:
visitor - is the visitor in the Visitor Pattern

createXPathResult

protected Node createXPathResult(Element parent)
Overrides:
createXPathResult in class AbstractNode


Copyright © 2001-2010. All Rights Reserved.