org.opendaylight.yangtools.yang.common

Class QName

java.lang.Object

org.opendaylight.yangtools.yang.common.QName

All Implemented Interfaces:

Serializable, Comparable<QName>, Immutable, MutationBehaviour<Immutable>

public final class QName
extends Object
implements Immutable, Serializable, Comparable<QName>

The QName from XML consists of local name of element and XML namespace, but for our use, we added module revision to it. In YANG context QName is full name of defined node, type, procedure or notification. QName consists of XML namespace, YANG model revision and local name of defined type. It is used to prevent name clashes between nodes with same local name, but from different schemas.

• XMLNamespace - getNamespace() - the namespace assigned to the YANG module which defined element, type, procedure or notification.
• Revision - getRevision() - the revision of the YANG module which describes the element
• LocalName - getLocalName() - the YANG schema identifier which were defined for this node in the YANG module

QName may also have prefix assigned, but prefix does not affect equality and identity of two QNames and carry only information which may be useful for serializers / deserializers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QName(URI namespace, String localName) QName Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(QName other)
static QName	create(QNameModule qnameModule, String localName) Creates new QName.
static QName	create(QName base, String localName)
static QName	create(String input)
static QName	create(String namespace, String localName) Creates new QName.
static QName	create(String namespace, String localName, Date revision) Creates new QName.
static QName	create(String namespace, String revision, String localName) Creates new QName.
static QName	create(URI namespace, Date revision, String localName) Creates new QName.
boolean	equals(Object obj) Compares the specified object with this list for equality.
static String	formattedRevision(Date revision) Formats Date representing revision to format YYYY-mm-dd YANG Specification defines format for revision as YYYY-mm-dd.
String	getFormattedRevision() Return string representation of revision in format YYYY-mm-dd YANG Specification defines format for revision as YYYY-mm-dd.
String	getLocalName() Returns YANG schema identifier which were defined for this node in the YANG module
QNameModule	getModule() Get the module component of the QName.
URI	getNamespace() Returns XMLNamespace assigned to the YANG module.
Date	getRevision() Returns revision of the YANG module if the module has defined revision, otherwise returns null
int	hashCode()
QName	intern() Return an interned reference to a equivalent QName.
boolean	isEqualWithoutRevision(QName other) Compares this QName to other, without comparing revision.
static Date	parseRevision(String formatedDate)
String	toString()
QName	withModule(QNameModule newModule) Creates copy of this with revision and prefix unset.
QName	withoutRevision() Returns a QName with the same namespace and local name, but with no revision.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QName

public QName(URI namespace,
             String localName)

QName Constructor.

Parameters:

namespace - the namespace assigned to the YANG module

localName - YANG schema identifier

Method Detail

create

public static QName create(String input)

getModule

public QNameModule getModule()

Get the module component of the QName.

Returns:

Module component

getNamespace

public URI getNamespace()

Returns XMLNamespace assigned to the YANG module.

Returns:

XMLNamespace assigned to the YANG module.

getLocalName

public String getLocalName()

Returns YANG schema identifier which were defined for this node in the YANG module

Returns:

YANG schema identifier which were defined for this node in the YANG module

getRevision

public Date getRevision()

Returns revision of the YANG module if the module has defined revision, otherwise returns null

Returns:

revision of the YANG module if the module has defined revision, otherwise returns null

intern

public QName intern()

Return an interned reference to a equivalent QName.

Returns:

Interned reference, or this object if it was interned.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Compares the specified object with this list for equality. Returns true if and only if the specified object is also instance of QName and its getLocalName(), getNamespace() and getRevision() are equals to same properties of this instance.

Overrides:

equals in class Object

Parameters:

obj - the object to be compared for equality with this QName

Returns:

true if the specified object is equal to this QName

create

public static QName create(QName base,
                           String localName)

create

public static QName create(QNameModule qnameModule,
                           String localName)

Creates new QName.

Parameters:

qnameModule - Namespace and revision enclosed as a QNameModule

localName - Local name part of QName. MUST NOT BE null.

Returns:

Instance of QName

create

public static QName create(URI namespace,
                           Date revision,
                           String localName)

Creates new QName.

Parameters:

namespace - Namespace of QName or null if namespace is undefined.

revision - Revision of namespace or null if revision is unspecified.

localName - Local name part of QName. MUST NOT BE null.

Returns:

Instance of QName

create

public static QName create(String namespace,
                           String localName,
                           Date revision)

Creates new QName.

Parameters:

namespace - Namespace of QName or null if namespace is undefined.

revision - Revision of namespace or null if revision is unspecified.

localName - Local name part of QName. MUST NOT BE null.

Returns:

Instance of QName

create

public static QName create(String namespace,
                           String revision,
                           String localName)

Creates new QName.

Parameters:

namespace - Namespace of QName, MUST NOT BE Null.

revision - Revision of namespace / YANG module. MUST NOT BE null, MUST BE in format YYYY-mm-dd.

localName - Local name part of QName. MUST NOT BE null.

Returns:

A new QName

Throws:

NullPointerException - If any of parameters is null.

IllegalArgumentException - If namespace is not valid URI or revision is not according to format YYYY-mm-dd.

create

public static QName create(String namespace,
                           String localName)

Creates new QName.

Parameters:

namespace - Namespace of QName, MUST NOT BE Null.

localName - Local name part of QName. MUST NOT BE null.

Returns:

A new QName

Throws:

NullPointerException - If any of parameters is null.

IllegalArgumentException - If namespace is not valid URI.

toString

public String toString()

Overrides:

toString in class Object

getFormattedRevision

public String getFormattedRevision()

Return string representation of revision in format YYYY-mm-dd YANG Specification defines format for revision as YYYY-mm-dd. This format for revision is reused accross multiple places such as capabilities URI, YANG modules, etc.

Returns:

String representation of revision or null, if revision is not set.

withModule

public QName withModule(@Nonnull
                        QNameModule newModule)

Creates copy of this with revision and prefix unset. Returns a QName with the specified QNameModule and the same localname as this one.

Parameters:

newModule - New QNameModule to use

Returns:

a QName with specified QNameModule and same local name as this one

withoutRevision

public QName withoutRevision()

Returns a QName with the same namespace and local name, but with no revision. If this QName does not have a Revision, this object is retured.

Returns:

copy of this QName with revision and prefix unset.

parseRevision

public static Date parseRevision(String formatedDate)

formattedRevision

public static String formattedRevision(Date revision)

Formats Date representing revision to format YYYY-mm-dd YANG Specification defines format for revision as YYYY-mm-dd. This format for revision is reused accross multiple places such as capabilities URI, YANG modules, etc.

Parameters:

revision - Date object to format or null

Returns:

String representation or null if the input was null.

isEqualWithoutRevision

public boolean isEqualWithoutRevision(QName other)

Compares this QName to other, without comparing revision. Compares instance of this to other instance of QName and returns true if both instances have equal localName (getLocalName() ) and namespace (getNamespace()).

Parameters:

other - Other QName. Must not be null.

Returns:

true if this instance and other have equals localName and namespace.

Throws:

NullPointerException - if other is null.

compareTo

public int compareTo(@Nonnull
                     QName other)

Specified by:

compareTo in interface Comparable<QName>