# QName

public class **QName** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [Serializable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Serializable.html) <br />

`QName` represents a **qualified name**
as defined in the XML specifications: [XML Schema Part2:
Datatypes specification](http://www.w3.org/TR/xmlschema-2/#QName), [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/#ns-qualnames), [Namespaces
in XML Errata](http://www.w3.org/XML/xml-names-19990114-errata).

The value of a `QName` contains a **Namespace
URI** , **local part** and
**prefix**.

The prefix is included in `QName` to retain lexical
information ***when present*** in an `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Source.html`. The prefix is
***NOT*** used in `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#equals(java.lang.Object)` or to compute the `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI`.
If not specified, the prefix is set to `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#DEFAULT_NS_PREFIX`.

`QName` is immutable.

<br />

##### See Also

- [XML Schema Part2: Datatypes specification](http://www.w3.org/TR/xmlschema-2/#QName)
- [Namespaces in XML](http://www.w3.org/TR/REC-xml-names/#ns-qualnames)
- [Namespaces in XML Errata](http://www.w3.org/XML/xml-names-19990114-errata)

### Public Constructor Summary

|---|---|
|   | [QName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) namespaceURI, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart) `QName` constructor specifying the Namespace URI and local part. |
|   | [QName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) namespaceURI, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) prefix) `QName` constructor specifying the Namespace URI, local part and prefix. |
|   | [QName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart) `QName` constructor specifying the local part. |

### Public Method Summary

|---|---|
| final boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) objectToTest) Test this `QName` for equality with another `Object`. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getLocalPart](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#getLocalPart())() Get the local part of this `QName`. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getNamespaceURI](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#getNamespaceURI())() Get the Namespace URI of this `QName`. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getPrefix](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#getPrefix())() Get the prefix of this `QName`. |
| final int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#hashCode())() Generate the hash code for this `QName`. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#toString())() `String` representation of this `QName`. |
| static [QName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html) | [valueOf](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#valueOf(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) qNameAsString) `QName` derived from parsing the formatted `String`. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**QName**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) namespaceURI, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart)

<br />

`QName` constructor specifying the Namespace URI
and local part.

If the Namespace URI is `null`, it is set to
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI`. This value represents no
explicitly defined Namespace as defined by the [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/#ns-qualnames) specification. This action preserves compatible
behavior with QName 1.0. Explicitly providing the `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI` value is the preferred coding
style.

If the local part is `null` an
`IllegalArgumentException` 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 `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#DEFAULT_NS_PREFIX`.

The Namespace URI is not validated as a
[URI reference](http://www.ietf.org/rfc/rfc2396.txt).
The local part is not validated as a
[NCName](http://www.w3.org/TR/REC-xml-names/#NT-NCName)
as specified in [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/).

<br />

##### Parameters

| namespaceURI | Namespace URI of the `QName` |
| localPart | local part of the `QName` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String,%20java.lang.String)`

#### public
**QName**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) namespaceURI, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) prefix)

<br />

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

If the Namespace URI is `null`, it is set to
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI`. This value represents no
explicitly defined Namespace as defined by the [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/#ns-qualnames) specification. This action preserves compatible
behavior with QName 1.0. Explicitly providing the `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI` value is the preferred coding
style.

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

If the prefix is `null`, an
`IllegalArgumentException` is thrown. Use `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#DEFAULT_NS_PREFIX` to explicitly indicate that no
prefix is present or the prefix is not relevant.

The Namespace URI is not validated as a
[URI reference](http://www.ietf.org/rfc/rfc2396.txt).
The local part and prefix are not validated as a
[NCName](http://www.w3.org/TR/REC-xml-names/#NT-NCName)
as specified in [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/).

<br />

##### Parameters

| namespaceURI | Namespace URI of the `QName` |
| localPart | local part of the `QName` |
| prefix | prefix of the `QName` |
|---|---|

#### public
**QName**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) localPart)

<br />

`QName` constructor specifying the local part.

If the local part is `null` an
`IllegalArgumentException` 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 to
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#NULL_NS_URI` and the prefix is set to `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String)` and
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String,%20java.lang.String)`
are preferred.*

The local part is not validated as a
[NCName](http://www.w3.org/TR/REC-xml-names/#NT-NCName)
as specified in [Namespaces
in XML](http://www.w3.org/TR/REC-xml-names/).

<br />

##### Parameters

| localPart | local part of the `QName` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#QName(java.lang.String,%20java.lang.String,%20java.lang.String)`

## Public Methods

#### public final boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) objectToTest)

<br />

Test this `QName` for equality with another
`Object`.

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

Two `QName`s 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object)`

<br />

##### Parameters

| objectToTest | the `Object` to test for equality with this `QName` |
|---|---|

##### Returns

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

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getLocalPart**
()

<br />

Get the local part of this `QName`.

<br />

##### Returns

- local part of this `QName`

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getNamespaceURI**
()

<br />

Get the Namespace URI of this `QName`.

<br />

##### Returns

- Namespace URI of this `QName`

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getPrefix**
()

<br />

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.

<br />

##### Returns

- prefix of this `QName`

#### public final int
**hashCode**
()

<br />

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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode()`.

<br />

##### Returns

- hash code for this `QName` `Object`

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()

<br />

`String` representation of this
`QName`.

The commonly accepted way of representing a `QName`
as a `String` was [defined](http://jclark.com/xml/xmlns.htm)
by James Clark. Although this is not a *standard*
specification, it is in common use, e.g. `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Transformer.html#setParameter(java.lang.String,%20java.lang.Object)`.
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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString()`.

<br />

##### Returns

- `String` representation of this `QName`

#### public static [QName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html)
**valueOf**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) qNameAsString)

<br />

`QName` derived from parsing the formatted
`String`.

If the `String` is `null` or does not conform to
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#toString()` formatting, an
`IllegalArgumentException` is thrown.

*The `String` **MUST** be in the
form returned by `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#toString()`.*

The commonly accepted way of representing a `QName`
as a `String` was [defined](http://jclark.com/xml/xmlns.htm)
by James Clark. Although this is not a *standard*
specification, it is in common use, e.g. `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Transformer.html#setParameter(java.lang.String,%20java.lang.Object)`.
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 to
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/XMLConstants.html#DEFAULT_NS_PREFIX`.

This method does not do full validation of the resulting
`QName`.

The Namespace URI is not validated as a
[URI reference](http://www.ietf.org/rfc/rfc2396.txt).
The local part is not validated as a
[NCName](http://www.w3.org/TR/REC-xml-names/#NT-NCName)
as specified in
[Namespaces in XML](http://www.w3.org/TR/REC-xml-names/).

<br />

##### Parameters

| qNameAsString | `String` representation of the `QName` |
|---|---|

##### Returns

- `QName` corresponding to the given `String`

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/namespace/QName.html#toString()`