@AlfrescoPublicApi public final class QName extends Object implements QNamePattern, Serializable, Cloneable, Comparable<QName>
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 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 |
---|---|
Object |
clone() |
int |
compareTo(QName qname)
Uses the
namespace URI and then the localname
to do the comparison i.e. |
static QName |
createQName(String qname)
Create a QName from its internal string representation of the following format:
{namespaceURI}localName |
static QName |
createQName(String qname,
NamespacePrefixResolver prefixResolver)
Create a QName (from prefix format)
prefix:localName |
static QName |
createQName(String namespaceURI,
String localName)
Create a QName
(With no prefix)
|
static QName |
createQName(String prefix,
String localName,
NamespacePrefixResolver prefixResolver)
Create a QName
|
static QName |
createQNameWithValidLocalName(String namespaceURI,
String localName)
Create a QName, optionally truncating the localname to
MAX_LENGTH . |
static String |
createValidLocalName(String name)
Create a valid local name from the specified name
|
boolean |
equals(Object object)
Two QNames are equal only when both their name and namespace match.
|
String |
getLocalName()
Gets the name
|
String |
getNamespaceURI()
Gets the namespace
|
QName |
getPrefixedQName(NamespacePrefixResolver resolver)
Gets a prefix resolved version of this QName
|
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,
String str)
Creates a QName representation for the given String.
|
static String |
resolveToQNameString(NamespacePrefixResolver prefixResolver,
String str)
Creates a string representation of a QName for the given string.
|
static String[] |
splitPrefixedQName(String qname)
Create a QName
|
String |
toPrefixString()
Render string representation of QName using format:
prefix:name |
String |
toPrefixString(NamespacePrefixResolver prefixResolver)
Render string representation of QName using format:
prefix:name
according to namespace prefix mappings of specified namespace resolver. |
String |
toString()
Render string representation of QName using format:
{namespace}name |
public static final 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(String namespaceURI, String localName) throws InvalidQNameException
namespaceURI
- the qualifying namespace (maybe null or empty string)localName
- the local nameInvalidQNameException
public static QName createQName(String prefix, 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(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(String qname) throws InvalidQNameException
{namespaceURI}localName
qname
- the string representation of the QNameIllegalArgumentException
InvalidQNameException
public static QName createQNameWithValidLocalName(String namespaceURI, String localName)
MAX_LENGTH
.namespaceURI
- the qualifying namespace (maybe null or empty string)localName
- the local name, which will be truncated, if necessarypublic static String createValidLocalName(String name)
name
- name to create valid local name frompublic static String[] splitPrefixedQName(String qname) throws InvalidQNameException, NamespaceException
qname
- qualified name of the following format prefix:localName
InvalidQNameException
NamespaceException
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public String getLocalName()
public String getNamespaceURI()
public QName getPrefixedQName(NamespacePrefixResolver resolver)
resolver
- namespace prefix resolverpublic boolean equals(Object object)
public boolean isMatch(QName qname)
isMatch
in interface QNamePattern
qname
- the instance to checkequals(Object)
public int hashCode()
public String toString()
{namespace}name
public int compareTo(QName qname)
namespace URI
and then the localname
to do the comparison i.e. the comparison is alphabetical.compareTo
in interface Comparable<QName>
public String toPrefixString()
prefix:name
public String getPrefixString()
public String toPrefixString(NamespacePrefixResolver prefixResolver)
prefix:name
according to namespace prefix mappings of specified namespace resolver.prefixResolver
- namespace prefix resolverpublic static QName resolveToQName(NamespacePrefixResolver prefixResolver, String str)
str
- The string to convertpublic static String resolveToQNameString(NamespacePrefixResolver prefixResolver, String str)
str
- The string to convertCopyright © 2005–2019 Alfresco Software. All rights reserved.