/* * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.Fpre * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.yangtools.yang.common; import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat; import java.io.Serializable; import java.net.URI; import java.net.URISyntaxException; import java.text.ParseException; import java.util.Date; import java.util.Objects; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.opendaylight.yangtools.concepts.Immutable; import org.opendaylight.yangtools.objcache.ObjectCache; import org.opendaylight.yangtools.objcache.ObjectCacheFactory; /** * 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. * *
prefix
assigned, but prefix does not
* affect equality and identity of two QNames and carry only information
* which may be useful for serializers / deserializers.
*
*
*/
public final class QName implements Immutable, Serializable, Comparablenull
*
* @return revision of the YANG module if the module has defined revision,
* otherwise returns null
*/
public Date getRevision() {
return module.getRevision();
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((localName == null) ? 0 : localName.hashCode());
result = prime * result + module.hashCode();
return result;
}
/**
*
* Compares the specified object with this list for equality. Returns
* true if and only if the specified object is also instance of
* {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
* {@link #getRevision()} are equals to same properties of this instance.
*
* @param obj the object to be compared for equality with this QName
* @return true if the specified object is equal to this QName
*
*/
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof QName)) {
return false;
}
final QName other = (QName) obj;
if (localName == null) {
if (other.localName != null) {
return false;
}
} else if (!localName.equals(other.localName)) {
return false;
}
return module.equals(other.module);
}
public static QName create(final QName base, final String localName) {
return create(base.getModule(), localName);
}
/**
* Creates new QName.
*
* @param qnameModule
* Namespace and revision enclosed as a QNameModule
* @param localName
* Local name part of QName. MUST NOT BE null.
* @return Instance of QName
*/
public static QName create(final QNameModule qnameModule, final String localName) {
if (qnameModule == null) {
throw new NullPointerException("module may not be null");
}
return new QName(qnameModule, localName);
}
/**
* Creates new QName.
*
* @param namespace
* Namespace of QName or null if namespace is undefined.
* @param revision
* Revision of namespace or null if revision is unspecified.
* @param localName
* Local name part of QName. MUST NOT BE null.
* @return Instance of QName
*/
public static QName create(final URI namespace, final Date revision, final String localName) {
return create(QNameModule.create(namespace, revision), localName);
}
/**
*
* Creates new QName.
*
* @param namespace
* Namespace of QName, MUST NOT BE Null.
* @param revision
* Revision of namespace / YANG module. MUST NOT BE null, MUST BE
* in format YYYY-mm-dd
.
* @param localName
* Local name part of QName. MUST NOT BE null.
* @return
* @throws NullPointerException
* If any of paramaters is null.
* @throws IllegalArgumentException
* If namespace
is not valid URI or
* revision
is not according to format
* YYYY-mm-dd
.
*/
public static QName create(final String namespace, final String revision, final String localName)
throws IllegalArgumentException {
final URI namespaceUri;
try {
namespaceUri = new URI(namespace);
} catch (URISyntaxException ue) {
throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
}
Date revisionDate = parseRevision(revision);
return create(namespaceUri, revisionDate, localName);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
if (getNamespace() != null) {
sb.append(QNAME_LEFT_PARENTHESIS + getNamespace());
if (getFormattedRevision() != null) {
sb.append(QNAME_REVISION_DELIMITER + getFormattedRevision());
}
sb.append(QNAME_RIGHT_PARENTHESIS);
}
sb.append(localName);
return sb.toString();
}
/**
* 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.
*
* @return String representation of revision or null, if revision is not
* set.
*/
public String getFormattedRevision() {
return module.getFormattedRevision();
}
/**
* Creates copy of this with revision and prefix unset.
*
* @return copy of this QName with revision and prefix unset.
*/
public QName withoutRevision() {
return create(getNamespace(), null, localName);
}
public static Date parseRevision(final String formatedDate) {
try {
return getRevisionFormat().parse(formatedDate);
} catch (ParseException | RuntimeException e) {
throw new IllegalArgumentException(
String.format("Revision '%s'is not in a supported format", formatedDate), e);
}
}
/**
* Formats {@link 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.
*
* @param revision
* Date object to format or null
* @return String representation or null if the input was null.
*/
public static String formattedRevision(final Date revision) {
if (revision == null) {
return null;
}
return getRevisionFormat().format(revision);
}
/**
*
* 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
({@link #getLocalName()}
* ) and namespace
({@link #getNamespace()}).
*
* @param other
* Other QName. Must not be null.
* @return true if this instance and other have equals localName and
* namespace.
* @throws NullPointerException
* if other
is null.
*/
public boolean isEqualWithoutRevision(final QName other) {
return localName.equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
}
@Override
public int compareTo(final QName other) {
// compare mandatory localName parameter
int result = localName.compareTo(other.localName);
if (result != 0) {
return result;
}
// compare nullable namespace parameter
if (getNamespace() == null) {
if (other.getNamespace() != null) {
return -1;
}
} else {
if (other.getNamespace() == null) {
return 1;
}
result = getNamespace().compareTo(other.getNamespace());
if (result != 0) {
return result;
}
}
// compare nullable revision parameter
if (getRevision() == null) {
if (other.getRevision() != null) {
return -1;
}
} else {
if (other.getRevision() == null) {
return 1;
}
result = getRevision().compareTo(other.getRevision());
if (result != 0) {
return result;
}
}
return result;
}
}