@AlfrescoPublicApi public final class QName extends java.lang.Object implements QNamePattern, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
QName
represents the qualified name of a Repository item. Each
QName consists of a local name qualified by a namespace.
The QNamePattern
is implemented
to allow instances of this class to be used for direct pattern matching where
required on interfaces.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EMPTY_URI_SUBSTITUTE |
static int |
MAX_LENGTH |
static char |
NAMESPACE_BEGIN |
static char |
NAMESPACE_END |
static char |
NAMESPACE_PREFIX |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
int |
compareTo(QName qname)
Uses the
namespace URI and then the localname
to do the comparison i.e. |
static QName |
createQName(java.lang.String qname)
Create a QName from its internal string representation of the following format:
{namespaceURI}localName |
static QName |
createQName(java.lang.String qname,
NamespacePrefixResolver prefixResolver)
Create a QName (from prefix format)
prefix:localName |
static QName |
createQName(java.lang.String namespaceURI,
java.lang.String localName)
Create a QName
(With no prefix)
|
static QName |
createQName(java.lang.String prefix,
java.lang.String localName,
NamespacePrefixResolver prefixResolver)
Create a QName
|
static QName |
createQNameWithValidLocalName(java.lang.String namespaceURI,
java.lang.String localName)
Create a QName, optionally truncating the localname to
QName.MAX_LENGTH . |
static java.lang.String |
createValidLocalName(java.lang.String name)
Create a valid local name from the specified name
|
boolean |
equals(java.lang.Object object)
Two QNames are equal only when both their name and namespace match.
|
java.lang.String |
getLocalName()
Gets the name
|
java.lang.String |
getNamespaceURI()
Gets the namespace
|
QName |
getPrefixedQName(NamespacePrefixResolver resolver)
Gets a prefix resolved version of this QName
|
java.lang.String |
getPrefixString()
Getter version of toPrefixString()
|
int |
hashCode()
Calculate hashCode.
|
boolean |
isMatch(QName qname)
Performs a direct comparison between qnames.
|
static QName |
resolveToQName(NamespacePrefixResolver prefixResolver,
java.lang.String str)
Creates a QName representation for the given String.
|
static java.lang.String |
resolveToQNameString(NamespacePrefixResolver prefixResolver,
java.lang.String str)
Creates a string representation of a QName for the given string.
|
static java.lang.String[] |
splitPrefixedQName(java.lang.String qname)
Create a QName
|
java.lang.String |
toPrefixString()
Render string representation of QName using format:
prefix:name |
java.lang.String |
toPrefixString(NamespacePrefixResolver prefixResolver)
Render string representation of QName using format:
prefix:name
according to namespace prefix mappings of specified namespace resolver. |
java.lang.String |
toString()
Render string representation of QName using format:
{namespace}name |
public static final java.lang.String EMPTY_URI_SUBSTITUTE
public static final char NAMESPACE_PREFIX
public static final char NAMESPACE_BEGIN
public static final char NAMESPACE_END
public static final int MAX_LENGTH
public static QName createQName(java.lang.String namespaceURI, java.lang.String localName) throws InvalidQNameException
namespaceURI
- the qualifying namespace (maybe null or empty string)localName
- the local nameInvalidQNameException
public static QName createQName(java.lang.String prefix, java.lang.String localName, NamespacePrefixResolver prefixResolver) throws InvalidQNameException, NamespaceException
prefix
- namespace prefix (maybe null or empty string)localName
- local nameprefixResolver
- lookup to resolve mappings between prefix and namespaceInvalidQNameException
NamespaceException
public static QName createQName(java.lang.String qname, NamespacePrefixResolver prefixResolver) throws InvalidQNameException, NamespaceException
prefix:localName
qname
- qualified name of the following format prefix:localName
prefixResolver
- lookup to resolve mappings between prefix and namespaceInvalidQNameException
NamespaceException
public static QName createQName(java.lang.String qname) throws InvalidQNameException
{namespaceURI}localName
qname
- the string representation of the QNamejava.lang.IllegalArgumentException
InvalidQNameException
public static QName createQNameWithValidLocalName(java.lang.String namespaceURI, java.lang.String localName)
QName.MAX_LENGTH
.namespaceURI
- the qualifying namespace (maybe null or empty string)localName
- the local name, which will be truncated, if necessarypublic static java.lang.String createValidLocalName(java.lang.String name)
name
- name to create valid local name frompublic static java.lang.String[] splitPrefixedQName(java.lang.String qname) throws InvalidQNameException, NamespaceException
qname
- qualified name of the following format prefix:localName
InvalidQNameException
NamespaceException
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public java.lang.String getLocalName()
public java.lang.String getNamespaceURI()
public QName getPrefixedQName(NamespacePrefixResolver resolver)
resolver
- namespace prefix resolverpublic boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public boolean isMatch(QName qname)
isMatch
in interface QNamePattern
qname
- the instance to checkQName.equals(Object)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
{namespace}name
toString
in class java.lang.Object
public int compareTo(QName qname)
namespace URI
and then the localname
to do the comparison i.e. the comparison is alphabetical.compareTo
in interface java.lang.Comparable
public java.lang.String toPrefixString()
prefix:name
public java.lang.String getPrefixString()
public java.lang.String toPrefixString(NamespacePrefixResolver prefixResolver)
prefix:name
according to namespace prefix mappings of specified namespace resolver.prefixResolver
- namespace prefix resolverpublic static QName resolveToQName(NamespacePrefixResolver prefixResolver, java.lang.String str)
str
- The string to convertpublic static java.lang.String resolveToQNameString(NamespacePrefixResolver prefixResolver, java.lang.String str)
str
- The string to convertCopyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.