| |
|
| java.lang.Object
 javax.xml.namespace.QName
| Constructor Summary | |
| public | QName(String namespaceURI, String localPart)
QName constructor specifying the Namespace URI
and local part.
If the Namespace URI is null, it is set to
javax.xml.XMLConstants.NULL_NS_URIXMLConstants.NULL_NS_URI . | | 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 to
javax.xml.XMLConstants.NULL_NS_URIXMLConstants.NULL_NS_URI . | | public | QName(String localPart)
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. |
| Method Summary | |
| final public boolean | equals(Object objectToTest)
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 QNames are considered equal if and only if
both the Namespace URI and local part are equal. | | public String | getLocalPart()
| | public String | getNamespaceURI()
| | public String | getPrefix()
Get the prefix of this QName.
The prefix assigned to a QName might
NOT be valid in a different
context. | | final public 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. | | public String | toString()
String representation of this
QName.
The commonly accepted way of representing a QName
as a String was
defined
by James Clark. | | public static QName | valueOf(String qNameAsString)
QName derived from parsing the formatted
String.
If the String is null or does not conform to
QName.toString() QName.toString() formatting, an
IllegalArgumentException is thrown.
The String MUST be in the
form returned by
QName.toString() QName.toString() .
The commonly accepted way of representing a QName
as a String was
defined
by James Clark. |
| QName | | public QName(String namespaceURI, String localPart, String prefix)(Code) | | QName constructor specifying the Namespace URI,
local part and prefix.
If the Namespace URI is null, it is set to
javax.xml.XMLConstants.NULL_NS_URIXMLConstants.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
javax.xml.XMLConstants.NULL_NS_URIXMLConstants.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
javax.xml.XMLConstants.DEFAULT_NS_PREFIXXMLConstants.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.
The local part and prefix are not validated as a
NCName
as specified in Namespaces
in XML.
Parameters:
namespaceURI - Namespace URI of the QName
Parameters:
localPart - local part of the QName
Parameters:
prefix - prefix of the QName
throws:
IllegalArgumentException - When localPartor prefix is null |
| QName | | public QName(String localPart)(Code) | | 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
javax.xml.XMLConstants.NULL_NS_URIXMLConstants.NULL_NS_URI and the prefix is set to
javax.xml.XMLConstants.DEFAULT_NS_PREFIXXMLConstants.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.QName(String namespaceURI,String localPart) QName(StringnamespaceURI, String localPart) and
QName.QName(String namespaceURI,String localPart,String prefix) are preferred.
The local part is not validated as a
NCName
as specified in Namespaces
in XML.
Parameters:
localPart - local part of the QName
throws:
IllegalArgumentException - When localPart isnull
See Also: QName.QName(String namespaceURI,String localPart)
See Also: QName(String
See Also: namespaceURI, String localPart)
See Also: QName.QName(String namespaceURI,String localPart,String prefix)
See Also: QName(String namespaceURI, String localPart, String
See Also: prefix) |
| equals | | final public boolean equals(Object objectToTest)(Code) | | 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 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
java.lang.Object.equals(Object) Object.equals(Object)
Parameters:
objectToTest - the Object to test forequality with this QName true if the given Object isequal to this QName else false |
| getLocalPart | | public String getLocalPart()(Code) | | Get the local part of this QName.
local part of this QName |
| getNamespaceURI | | public String getNamespaceURI()(Code) | | Get the Namespace URI of this QName.
Namespace URI of this QName |
| getPrefix | | public String getPrefix()(Code) | | 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.
prefix of this QName |
| hashCode | | final public int hashCode()(Code) | | 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
java.lang.Object.hashCode Object.hashCode() .
hash code for this QName Object |
| toString | | public String toString()(Code) | | String representation of this
QName.
The commonly accepted way of representing a QName
as a String was
defined
by James Clark. Although this is not a standard
specification, it is in common use, e.g.
javax.xml.transform.Transformer.setParameter(String nameObject value) .
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
java.lang.Object.toString Object.toString() .
String representation of this QName |
| valueOf | | public static QName valueOf(String qNameAsString)(Code) | | QName derived from parsing the formatted
String.
If the String is null or does not conform to
QName.toString() QName.toString() formatting, an
IllegalArgumentException is thrown.
The String MUST be in the
form returned by
QName.toString() QName.toString() .
The commonly accepted way of representing a QName
as a String was
defined
by James Clark. Although this is not a standard
specification, it is in common use, e.g.
javax.xml.transform.Transformer.setParameter(String nameObject value) .
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
javax.xml.XMLConstants.DEFAULT_NS_PREFIXXMLConstants.DEFAULT_NS_PREFIX .
This method does not do full validation of the resulting
QName.
The Namespace URI is not validated as a
URI reference.
The local part is not validated as a
NCName
as specified in
Namespaces in XML.
Parameters:
qNameAsString - String representationof the QName
throws:
IllegalArgumentException - When qNameAsString isnull or malformed QName corresponding to the given String
See Also: QName.toString()
See Also: QName.toString() |
|
|
|