2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.common;
10 import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Strings;
14 import com.google.common.collect.Interner;
15 import com.google.common.collect.Interners;
16 import java.io.Serializable;
18 import java.net.URISyntaxException;
19 import java.text.ParseException;
20 import java.util.Date;
21 import java.util.Objects;
22 import java.util.regex.Matcher;
23 import java.util.regex.Pattern;
24 import org.opendaylight.yangtools.concepts.Immutable;
27 * The QName from XML consists of local name of element and XML namespace, but
28 * for our use, we added module revision to it.
30 * In YANG context QName is full name of defined node, type, procedure or
31 * notification. QName consists of XML namespace, YANG model revision and local
32 * name of defined type. It is used to prevent name clashes between nodes with
33 * same local name, but from different schemas.
36 * <li><b>XMLNamespace</b> - {@link #getNamespace()} - the namespace assigned to the YANG module which
37 * defined element, type, procedure or notification.</li>
38 * <li><b>Revision</b> - {@link #getRevision()} - the revision of the YANG module which describes the
40 * <li><b>LocalName</b> - {@link #getLocalName()} - the YANG schema identifier which were defined for this
41 * node in the YANG module</li>
44 * QName may also have <code>prefix</code> assigned, but prefix does not
45 * affect equality and identity of two QNames and carry only information
46 * which may be useful for serializers / deserializers.
50 public final class QName implements Immutable, Serializable, Comparable<QName> {
51 private static final Interner<QName> INTERNER = Interners.newWeakInterner();
52 private static final long serialVersionUID = 5398411242927766414L;
54 static final String QNAME_REVISION_DELIMITER = "?revision=";
55 static final String QNAME_LEFT_PARENTHESIS = "(";
56 static final String QNAME_RIGHT_PARENTHESIS = ")";
58 private static final Pattern QNAME_PATTERN_FULL = Pattern.compile("^\\((.+)\\" + QNAME_REVISION_DELIMITER
60 private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile("^\\((.+)\\)(.+)$");
61 private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION = Pattern.compile("^(.+)$");
62 private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&' };
65 private final QNameModule module;
67 private final String localName;
68 private transient int hash;
70 private QName(final QNameModule module, final String localName) {
71 this.localName = checkLocalName(localName);
79 * the namespace assigned to the YANG module
81 * YANG schema identifier
83 public QName(final URI namespace, final String localName) {
84 this(QNameModule.create(namespace, null), localName);
87 private static String checkLocalName(final String localName) {
88 Preconditions.checkArgument(localName != null, "Parameter 'localName' may not be null.");
89 Preconditions.checkArgument(!Strings.isNullOrEmpty(localName), "Parameter 'localName' must be a non-empty string.");
91 for (final char c : ILLEGAL_CHARACTERS) {
92 if (localName.indexOf(c) != -1) {
93 throw new IllegalArgumentException(String.format(
94 "Parameter 'localName':'%s' contains illegal character '%s'", localName, c));
100 public static QName create(final String input) {
101 Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
102 if (matcher.matches()) {
103 final String namespace = matcher.group(1);
104 final String revision = matcher.group(2);
105 final String localName = matcher.group(3);
106 return create(namespace, revision, localName);
108 matcher = QNAME_PATTERN_NO_REVISION.matcher(input);
109 if (matcher.matches()) {
110 final URI namespace = URI.create(matcher.group(1));
111 final String localName = matcher.group(2);
112 return new QName(namespace, localName);
114 matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
115 if (matcher.matches()) {
116 final String localName = matcher.group(1);
117 return new QName((URI) null, localName);
119 throw new IllegalArgumentException("Invalid input:" + input);
123 * Get the module component of the QName.
125 * @return Module component
127 public QNameModule getModule() {
132 * Returns XMLNamespace assigned to the YANG module.
134 * @return XMLNamespace assigned to the YANG module.
136 public URI getNamespace() {
137 return module.getNamespace();
141 * Returns YANG schema identifier which were defined for this node in the
144 * @return YANG schema identifier which were defined for this node in the
147 public String getLocalName() {
152 * Returns revision of the YANG module if the module has defined revision,
153 * otherwise returns <code>null</code>
155 * @return revision of the YANG module if the module has defined revision,
156 * otherwise returns <code>null</code>
158 public Date getRevision() {
159 return module.getRevision();
163 * Return an interned reference to a equivalent QName.
165 * @return Interned reference, or this object if it was interned.
167 public QName intern() {
168 // We also want to make sure we keep the QNameModule cached
169 final QNameModule cacheMod = module.intern();
171 // Identity comparison is here on purpose, as we are deciding whether to potentially store 'qname' into the
172 // interner. It is important that it does not hold user-supplied reference (such a String instance from
173 // parsing of an XML document).
174 final QName template = cacheMod == module ? this : QName.create(cacheMod, localName);
176 return INTERNER.intern(template);
180 public int hashCode() {
182 hash = Objects.hash(module, localName);
189 * Compares the specified object with this list for equality. Returns
190 * <tt>true</tt> if and only if the specified object is also instance of
191 * {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
192 * {@link #getRevision()} are equals to same properties of this instance.
194 * @param obj the object to be compared for equality with this QName
195 * @return <tt>true</tt> if the specified object is equal to this QName
199 public boolean equals(final Object obj) {
203 if (!(obj instanceof QName)) {
206 final QName other = (QName) obj;
207 return Objects.equals(localName, other.localName) && module.equals(other.module);
210 public static QName create(final QName base, final String localName) {
211 return create(base.getModule(), localName);
218 * Namespace and revision enclosed as a QNameModule
220 * Local name part of QName. MUST NOT BE null.
221 * @return Instance of QName
223 public static QName create(final QNameModule qnameModule, final String localName) {
224 return new QName(Preconditions.checkNotNull(qnameModule,"module may not be null"), localName);
231 * Namespace of QName or null if namespace is undefined.
233 * Revision of namespace or null if revision is unspecified.
235 * Local name part of QName. MUST NOT BE null.
236 * @return Instance of QName
238 public static QName create(final URI namespace, final Date revision, final String localName) {
239 return create(QNameModule.create(namespace, revision), localName);
247 * Namespace of QName, MUST NOT BE Null.
249 * Revision of namespace / YANG module. MUST NOT BE null, MUST BE
250 * in format <code>YYYY-mm-dd</code>.
252 * Local name part of QName. MUST NOT BE null.
254 * @throws NullPointerException
255 * If any of parameters is null.
256 * @throws IllegalArgumentException
257 * If <code>namespace</code> is not valid URI or
258 * <code>revision</code> is not according to format
259 * <code>YYYY-mm-dd</code>.
261 public static QName create(final String namespace, final String revision, final String localName) {
262 final URI namespaceUri = parseNamespace(namespace);
263 final Date revisionDate = parseRevision(revision);
264 return create(namespaceUri, revisionDate, localName);
267 private static URI parseNamespace(final String namespace) {
269 return new URI(namespace);
270 } catch (final URISyntaxException ue) {
271 throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
279 * Namespace of QName, MUST NOT BE Null.
281 * Local name part of QName. MUST NOT BE null.
283 * @throws NullPointerException
284 * If any of parameters is null.
285 * @throws IllegalArgumentException
286 * If <code>namespace</code> is not valid URI.
288 public static QName create(final String namespace, final String localName) {
289 return create(parseNamespace(namespace), null, localName);
293 public String toString() {
294 final StringBuilder sb = new StringBuilder();
295 if (getNamespace() != null) {
296 sb.append(QNAME_LEFT_PARENTHESIS).append(getNamespace());
298 if (getFormattedRevision() != null) {
299 sb.append(QNAME_REVISION_DELIMITER).append(getFormattedRevision());
301 sb.append(QNAME_RIGHT_PARENTHESIS);
303 sb.append(localName);
304 return sb.toString();
308 * Return string representation of revision in format
309 * <code>YYYY-mm-dd</code>
311 * YANG Specification defines format for <code>revision</code> as
312 * YYYY-mm-dd. This format for revision is reused accross multiple places
313 * such as capabilities URI, YANG modules, etc.
315 * @return String representation of revision or null, if revision is not
318 public String getFormattedRevision() {
319 return module.getFormattedRevision();
323 * Creates copy of this with revision and prefix unset.
325 * @return copy of this QName with revision and prefix unset.
327 public QName withoutRevision() {
328 return create(getNamespace(), null, localName);
331 public static Date parseRevision(final String formatedDate) {
333 return getRevisionFormat().parse(formatedDate);
334 } catch (ParseException | RuntimeException e) {
335 throw new IllegalArgumentException(
336 String.format("Revision '%s'is not in a supported format", formatedDate), e);
341 * Formats {@link Date} representing revision to format
342 * <code>YYYY-mm-dd</code>
344 * YANG Specification defines format for <code>revision</code> as
345 * YYYY-mm-dd. This format for revision is reused accross multiple places
346 * such as capabilities URI, YANG modules, etc.
349 * Date object to format or null
350 * @return String representation or null if the input was null.
352 public static String formattedRevision(final Date revision) {
353 if (revision == null) {
356 return getRevisionFormat().format(revision);
361 * Compares this QName to other, without comparing revision.
363 * Compares instance of this to other instance of QName and returns true if
364 * both instances have equal <code>localName</code> ({@link #getLocalName()}
365 * ) and <code>namespace</code> ({@link #getNamespace()}).
368 * Other QName. Must not be null.
369 * @return true if this instance and other have equals localName and
371 * @throws NullPointerException
372 * if <code>other</code> is null.
374 public boolean isEqualWithoutRevision(final QName other) {
375 return localName.equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
379 public int compareTo(final QName other) {
380 // compare mandatory localName parameter
381 int result = localName.compareTo(other.localName);
386 // compare nullable namespace parameter
387 if (getNamespace() == null) {
388 if (other.getNamespace() != null) {
392 if (other.getNamespace() == null) {
395 result = getNamespace().compareTo(other.getNamespace());
401 // compare nullable revision parameter
402 if (getRevision() == null) {
403 if (other.getRevision() != null) {
407 if (other.getRevision() == null) {
410 result = getRevision().compareTo(other.getRevision());