Spring Web Services Framework

org.springframework.xml.namespace
Class QNameUtils

java.lang.Object
  extended by org.springframework.xml.namespace.QNameUtils

public abstract class QNameUtils
extends Object

Helper class for using QName.

Since:
1.0.0
Author:
Arjen Poutsma
See Also:
QName

Constructor Summary
QNameUtils()
           
 
Method Summary
static QName createQName(String namespaceUri, String localPart, String prefix)
          Creates a new QName with the given parameters.
static String getPrefix(QName qName)
          Returns the prefix of the given QName.
static QName getQNameForNode(Node node)
          Returns the qualified name of the given DOM Node.
static QName parseQNameString(String qNameString)
          Parse the given qualified name string into a QName.
static QName toQName(String namespaceUri, String qualifiedName)
          Convert a namespace URI and DOM or SAX qualified name to a QName.
static String toQualifiedName(QName qName)
          Convert a QName to a qualified name, as used by DOM and SAX.
static boolean validateQName(String text)
          Validates the given String as a QName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QNameUtils

public QNameUtils()
Method Detail

createQName

public static QName createQName(String namespaceUri,
                                String localPart,
                                String prefix)
Creates a new QName with the given parameters. Sets the prefix if possible, i.e. if the QName(String, String, String) constructor can be found. If this constructor is not available (as is the case on older implementations of JAX-RPC), the prefix is ignored.

Parameters:
namespaceUri - namespace URI of the QName
localPart - local part of the QName
prefix - prefix of the QName. May be ignored.
Returns:
the created QName
See Also:
QName.QName(String,String,String)

getPrefix

public static String getPrefix(QName qName)
Returns the prefix of the given QName. Returns the prefix if available, i.e. if the QName.getPrefix() method can be found. If this method is not available (as is the case on older implementations of JAX-RPC), an empty string is returned.

Parameters:
qName - the QName to return the prefix from
Returns:
the prefix, if available, or an empty string
See Also:
QName.getPrefix()

validateQName

public static boolean validateQName(String text)
Validates the given String as a QName

Parameters:
text - the qualified name
Returns:
true if valid, false otherwise

getQNameForNode

public static QName getQNameForNode(Node node)
Returns the qualified name of the given DOM Node.

Parameters:
node - the node
Returns:
the qualified name of the node

toQualifiedName

public static String toQualifiedName(QName qName)
Convert a QName to a qualified name, as used by DOM and SAX. The returned string has a format of prefix:localName if the prefix is set, or just localName if not.

Parameters:
qName - the QName
Returns:
the qualified name

toQName

public static QName toQName(String namespaceUri,
                            String qualifiedName)
Convert a namespace URI and DOM or SAX qualified name to a QName. The qualified name can have the form prefix:localname or localName.

Parameters:
namespaceUri - the namespace URI
qualifiedName - the qualified name
Returns:
a QName

parseQNameString

public static QName parseQNameString(String qNameString)
Parse the given qualified name string into a QName. Expects the syntax localPart, {namespace}localPart, or {namespace}prefix:localPart. This format resembles the toString() representation of QName itself, but allows for prefixes to be specified as well.

Returns:
a corresponding QName instance
Throws:
IllegalArgumentException - when the given string is null or empty.

Spring Web Services Framework

Copyright © 2005-2010 The Spring Web Services Framework. All Rights Reserved.