QName (Java Platform SE 6) (original) (raw)

javax.xml.namespace

Class QName

java.lang.Object javax.xml.namespace.QName

All Implemented Interfaces:

Serializable

public class QName

extends Object

implements Serializable

QName represents a qualified name as defined in the XML specifications: XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata.

The value of a QName contains a Namespace URI, local part andprefix.

The prefix is included in QName to retain lexical information when present in an XML input source. The prefix is**NOT** used in QName.equals(Object) or to compute the QName.hashCode(). Equality and the hash code are defined using**only** the Namespace URI and local part.

If not specified, the Namespace URI is set to XMLConstants.NULL_NS_URI. If not specified, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

QName is immutable.

Since:

1.5

See Also:

XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata, Serialized Form

QName

public QName(String namespaceURI, String localPart)

QName constructor specifying the Namespace URI and local part.

If the Namespace URI is null, it is set toXMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null anIllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

The Namespace URI is not validated as aURI reference. The local part is not validated as aNCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - When localPart isnull

See Also:

[QName(String namespaceURI, String localPart, String prefix)](../../../javax/xml/namespace/QName.html#QName%28java.lang.String, java.lang.String, java.lang.String%29)

QName

public QName(String namespaceURI, String localPart, String prefix)

QName constructor specifying the Namespace URI, local part and prefix.

If the Namespace URI is null, it is set toXMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null anIllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

If the prefix is null, anIllegalArgumentException is thrown. Use XMLConstants.DEFAULT_NS_PREFIX to explicitly indicate that no prefix is present or the prefix is not relevant.

The Namespace URI is not validated as aURI reference. The local part and prefix are not validated as aNCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

prefix - prefix of the QName

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - When localPart or prefix is null

QName

public QName(String localPart)

QName constructor specifying the local part.

If the local part is null anIllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the Namespace URI is set toXMLConstants.NULL_NS_URI and the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

In an XML context, all Element and Attribute names exist in the context of a Namespace. Making this explicit during the construction of a QName helps prevent hard to diagnosis XML validity errors. The constructors [QName(String namespaceURI, String localPart)](../../../javax/xml/namespace/QName.html#QName%28java.lang.String, java.lang.String%29) and[QName(String namespaceURI, String localPart, String prefix)](../../../javax/xml/namespace/QName.html#QName%28java.lang.String, java.lang.String, java.lang.String%29) are preferred.

The local part is not validated as aNCName as specified in Namespaces in XML.

Parameters:

localPart - local part of the QName

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - When localPart isnull

See Also:

[QName(String namespaceURI, String localPart)](../../../javax/xml/namespace/QName.html#QName%28java.lang.String, java.lang.String%29), [QName(String namespaceURI, String localPart, String prefix)](../../../javax/xml/namespace/QName.html#QName%28java.lang.String, java.lang.String, java.lang.String%29)

getNamespaceURI

public String getNamespaceURI()

Get the Namespace URI of this QName.

Returns:

Namespace URI of this QName

getLocalPart

public String getLocalPart()

Get the local part of this QName.

Returns:

local part of this QName

getPrefix

public String getPrefix()

Get the prefix of this QName.

The prefix assigned to a QName might**NOT** be valid in a different context. For example, a QName may be assigned a prefix in the context of parsing a document but that prefix may be invalid in the context of a different document.

Returns:

prefix of this QName

equals

public final boolean equals(Object objectToTest)

Test this QName for equality with anotherObject.

If the Object to be tested is not aQName or is null, then this method returns false.

Two QNames are considered equal if and only if both the Namespace URI and local part are equal. This method uses String.equals() to check equality of the Namespace URI and local part. The prefix is**NOT** used to determine equality.

This method satisfies the general contract of Object.equals(Object)

Overrides:

[equals](../../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Parameters:

objectToTest - the Object to test for equality with this QName

Returns:

true if the given Object is equal to this QName else false

See Also:

Object.hashCode(), Hashtable

hashCode

public final int hashCode()

Generate the hash code for this QName.

The hash code is calculated using both the Namespace URI and the local part of the QName. The prefix is**NOT** used to calculate the hash code.

This method satisfies the general contract of Object.hashCode().

Overrides:

[hashCode](../../../java/lang/Object.html#hashCode%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

hash code for this QName Object

See Also:

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

String representation of thisQName.

The commonly accepted way of representing a QName as a String wasdefined by James Clark. Although this is not a standard specification, it is in common use, e.g. [Transformer.setParameter(String name, Object value)](../../../javax/xml/transform/Transformer.html#setParameter%28java.lang.String, java.lang.Object%29). This implementation represents a QName as: "{" + Namespace URI + "}" + local part. If the Namespace URI.equals(XMLConstants.NULL_NS_URI), only the local part is returned. An appropriate use of this method is for debugging or logging for human consumption.

Note the prefix value is NOT returned as part of the String representation.

This method satisfies the general contract of Object.toString().

Overrides:

[toString](../../../java/lang/Object.html#toString%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

String representation of this QName

valueOf

public static QName valueOf(String qNameAsString)

QName derived from parsing the formattedString.

If the String is null or does not conform toQName.toString() formatting, anIllegalArgumentException is thrown.

The String MUST be in the form returned by QName.toString().

The commonly accepted way of representing a QName as a String wasdefined by James Clark. Although this is not a standard specification, it is in common use, e.g. [Transformer.setParameter(String name, Object value)](../../../javax/xml/transform/Transformer.html#setParameter%28java.lang.String, java.lang.Object%29). This implementation parses a String formatted as: "{" + Namespace URI + "}" + local part. If the Namespace URI .equals(XMLConstants.NULL_NS_URI), only the local part should be provided.

The prefix value CANNOT be represented in the String and will be set toXMLConstants.DEFAULT_NS_PREFIX.

This method does not do full validation of the resultingQName.

The Namespace URI is not validated as aURI reference. The local part is not validated as aNCName as specified inNamespaces in XML.

Parameters:

qNameAsString - String representation of the QName

Returns:

QName corresponding to the given String

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - When qNameAsString isnull or malformed

See Also:

QName.toString()

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.