Package Summary  Overview Summary

class:QName [NONE]

constructor:<init>(java.lang.String,java.lang.String) [NONE]

constructor:<init>(java.lang.String,java.lang.String,java.lang.String) [NONE]

  • 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 to XMLConstants.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 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 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 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
    localPart - local part of the QName
    prefix - prefix of the QName
    Throws:
    IllegalArgumentException - When localPart or prefix is null

constructor:<init>(java.lang.String) [NONE]

method:getNamespaceURI() [NONE]

  • getNamespaceURI

    public String getNamespaceURI()

    Get the Namespace URI of this QName.

    Returns:
    Namespace URI of this QName

method:getLocalPart() [NONE]

  • getLocalPart

    public String getLocalPart()

    Get the local part of this QName.

    Returns:
    local part of this QName

method:getPrefix() [NONE]

  • 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

method:equals(java.lang.Object) [NONE]

  • equals

    public final 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. 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 in class Object
    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(), HashMap

method:hashCode() [NONE]

method:toString() [NONE]

  • toString

    public String toString()

    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. Transformer.setParameter(String name, Object 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 Object.toString().

    Overrides:
    toString in class Object
    Returns:
    String representation of this QName

method:valueOf(java.lang.String) [NONE]

  • valueOf

    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() formatting, an IllegalArgumentException is thrown.

    The StringMUST be in the form returned by 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. Transformer.setParameter(String name, Object 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 XMLConstants.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 representation of the QName
    Returns:
    QName corresponding to the given String
    Throws:
    IllegalArgumentException - When qNameAsString is null or malformed
    See Also:
    QName.toString()

© 2018 Oracle Corporation and/or its affiliates