Package org.dom4j

Class QName

java.lang.Object

org.dom4j.QName

All Implemented Interfaces:

java.io.Serializable

public class QName
extends java.lang.Object
implements java.io.Serializable

QName represents a qualified name value of an XML element or attribute. It consists of a local name and a Namespaceinstance. This object is immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private DocumentFactory	documentFactory	The document factory used for this QName if specified or null
private int	hashCode	A cached version of the hashcode for efficiency
private java.lang.String	name	The local name of the element or attribute
private static java.lang.String	NAME_CHAR	NameChar without colon.
private static java.lang.String	NAME_START_CHAR	NameStartChar without colon.
private Namespace	namespace	The Namespace of this element or attribute
private static java.lang.String	NCNAME	NCName
private java.lang.String	qualifiedName	The qualified name of the element or attribute
private static java.util.regex.Pattern	RE_NAME	Regular expression for Name (with colon).
private static java.util.regex.Pattern	RE_NCNAME	Regular expression for NCName.
private static java.util.regex.Pattern	RE_QNAME	Regular expression for QName.
private static SingletonStrategy<QNameCache>	singleton	The Singleton instance

Constructor Summary

Constructors

Constructor	Description
QName(java.lang.String name)
QName(java.lang.String name, Namespace namespace)
QName(java.lang.String name, Namespace namespace, java.lang.String qualifiedName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object object)
static QName	get(java.lang.String name)
static QName	get(java.lang.String qualifiedName, java.lang.String uri)
static QName	get(java.lang.String name, java.lang.String prefix, java.lang.String uri)
static QName	get(java.lang.String name, Namespace namespace)
static QName	get(java.lang.String localName, Namespace namespace, java.lang.String qualifiedName)
private static QNameCache	getCache()
DocumentFactory	getDocumentFactory()	DOCUMENT ME!
java.lang.String	getName()	DOCUMENT ME!
Namespace	getNamespace()	DOCUMENT ME!
java.lang.String	getNamespacePrefix()	DOCUMENT ME!
java.lang.String	getNamespaceURI()	DOCUMENT ME!
java.lang.String	getQualifiedName()	DOCUMENT ME!
int	hashCode()	DOCUMENT ME!
private void	readObject(java.io.ObjectInputStream in)
void	setDocumentFactory(DocumentFactory documentFactory)
java.lang.String	toString()
private static void	validateName(java.lang.String name)
protected static void	validateNCName(java.lang.String ncname)
private static void	validateQName(java.lang.String qname)
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

singleton

private static SingletonStrategy<QNameCache> singleton

The Singleton instance

NAME_START_CHAR

private static final java.lang.String NAME_START_CHAR

NameStartChar without colon.

NameStartChar   ::=     ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]

See Also:

XML 1.0 – 2.3 Common Syntactic Constructs, XML 1.1 – 2.3 Common Syntactic Constructs, Constant Field Values

NAME_CHAR

private static final java.lang.String NAME_CHAR

NameChar without colon.

NameChar        ::=     NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]

See Also:

XML 1.0 – 2.3 Common Syntactic Constructs, XML 1.1 – 2.3 Common Syntactic Constructs, Constant Field Values

NCNAME

private static final java.lang.String NCNAME

NCName

 NCName         ::=     NCNameStartChar NCNameChar*     (An XML Name, minus the ":")
 NCNameChar     ::=     NameChar -':'
 NCNameStartChar        ::=     NameStartChar -':'
 

See Also:

Namespaces in XML 1.0 – 4 Qualified Names, Namespaces in XML 1.1 – 4 Qualified Names, Constant Field Values

RE_NAME

private static final java.util.regex.Pattern RE_NAME

Regular expression for Name (with colon).

Name    ::=     NameStartChar (NameChar)*

See Also:

XML 1.0 – 2.3 Common Syntactic Constructs, XML 1.1 – 2.3 Common Syntactic Constructs

RE_NCNAME

private static final java.util.regex.Pattern RE_NCNAME

Regular expression for NCName.

 NCName         ::=     NCNameStartChar NCNameChar*     (An XML Name, minus the ":")
 NCNameChar     ::=     NameChar -':'
 NCNameStartChar        ::=     NameStartChar -':'
 

See Also:

Namespaces in XML 1.0 – 4 Qualified Names, Namespaces in XML 1.1 – 4 Qualified Names

RE_QNAME

private static final java.util.regex.Pattern RE_QNAME

Regular expression for QName.

 QName          ::=     PrefixedName | UnprefixedName
 PrefixedName   ::=     Prefix ':' LocalPart
 UnprefixedName ::=     LocalPart
 Prefix         ::=     NCName
 LocalPart      ::=     NCName
 

See Also:

Namespaces in XML 1.0 – 4 Qualified Names, Namespaces in XML 1.1 – 4 Qualified Names

name

private java.lang.String name

The local name of the element or attribute

qualifiedName

private java.lang.String qualifiedName

The qualified name of the element or attribute

namespace

private transient Namespace namespace

The Namespace of this element or attribute

hashCode

private int hashCode

A cached version of the hashcode for efficiency

documentFactory

private DocumentFactory documentFactory

The document factory used for this QName if specified or null

Constructor Detail

QName

public QName(java.lang.String name)

QName

public QName(java.lang.String name,
             Namespace namespace)

QName

public QName(java.lang.String name,
             Namespace namespace,
             java.lang.String qualifiedName)

Method Detail

get

public static QName get(java.lang.String name)

get

public static QName get(java.lang.String name,
                        Namespace namespace)

get

public static QName get(java.lang.String name,
                        java.lang.String prefix,
                        java.lang.String uri)

get

public static QName get(java.lang.String qualifiedName,
                        java.lang.String uri)

get

public static QName get(java.lang.String localName,
                        Namespace namespace,
                        java.lang.String qualifiedName)

getName

public java.lang.String getName()

DOCUMENT ME!

Returns:

the local name

getQualifiedName

public java.lang.String getQualifiedName()

DOCUMENT ME!

Returns:

the qualified name in the format prefix:localName

getNamespace

public Namespace getNamespace()

DOCUMENT ME!

Returns:

the namespace of this QName

getNamespacePrefix

public java.lang.String getNamespacePrefix()

DOCUMENT ME!

Returns:

the namespace URI of this QName

getNamespaceURI

public java.lang.String getNamespaceURI()

DOCUMENT ME!

Returns:

the namespace URI of this QName

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.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDocumentFactory

public DocumentFactory getDocumentFactory()

DOCUMENT ME!

Returns:

the factory that should be used for Elements of this QName

setDocumentFactory

public void setDocumentFactory(DocumentFactory documentFactory)

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getCache

private static QNameCache getCache()

validateName

private static void validateName(java.lang.String name)

validateNCName

protected static void validateNCName(java.lang.String ncname)

validateQName

private static void validateQName(java.lang.String qname)