Add QName.withModule(QNameModule) method
[yangtools.git] / yang / yang-common / src / main / java / org / opendaylight / yangtools / yang / common / QName.java
index 97a9aaab1ae16d167c0f532572c298b8af65c86d..40b6c70cfca06cc3a9bcccd410935f403025ae0d 100644 (file)
@@ -10,7 +10,6 @@ package org.opendaylight.yangtools.yang.common;
 import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat;
 
 import com.google.common.base.Preconditions;
-import com.google.common.base.Strings;
 import com.google.common.collect.Interner;
 import com.google.common.collect.Interners;
 import java.io.Serializable;
@@ -21,6 +20,8 @@ import java.util.Date;
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import javax.annotation.Nonnull;
+import javax.annotation.RegEx;
 import org.opendaylight.yangtools.concepts.Immutable;
 
 /**
@@ -55,16 +56,26 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
     static final String QNAME_LEFT_PARENTHESIS = "(";
     static final String QNAME_RIGHT_PARENTHESIS = ")";
 
-    private static final Pattern QNAME_PATTERN_FULL = Pattern.compile("^\\((.+)\\" + QNAME_REVISION_DELIMITER
-            + "(.+)\\)(.+)$");
-    private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile("^\\((.+)\\)(.+)$");
-    private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION = Pattern.compile("^(.+)$");
-    private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&' };
+    @RegEx
+    private static final String QNAME_STRING_FULL = "^\\((.+)\\?revision=(.+)\\)(.+)$";
+    private static final Pattern QNAME_PATTERN_FULL = Pattern.compile(QNAME_STRING_FULL);
 
-    // Mandatory
+    @RegEx
+    private static final String QNAME_STRING_NO_REVISION = "^\\((.+)\\)(.+)$";
+    private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile(QNAME_STRING_NO_REVISION);
+
+    @RegEx
+    private static final String QNAME_STRING_NO_NAMESPACE_NO_REVISION = "^(.+)$";
+    private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION =
+        Pattern.compile(QNAME_STRING_NO_NAMESPACE_NO_REVISION);
+
+    private static final char[] ILLEGAL_CHARACTERS = { '?', '(', ')', '&', ':' };
+
+    // Non-null
     private final QNameModule module;
-    // Mandatory
+    // Non-null
     private final String localName;
+    private transient int hash;
 
     private QName(final QNameModule module, final String localName) {
         this.localName = checkLocalName(localName);
@@ -85,12 +96,12 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
 
     private static String checkLocalName(final String localName) {
         Preconditions.checkArgument(localName != null, "Parameter 'localName' may not be null.");
-               Preconditions.checkArgument(!Strings.isNullOrEmpty(localName), "Parameter 'localName' must be a non-empty string.");
+        Preconditions.checkArgument(!localName.isEmpty(), "Parameter 'localName' must be a non-empty string.");
 
         for (final char c : ILLEGAL_CHARACTERS) {
             if (localName.indexOf(c) != -1) {
-                throw new IllegalArgumentException(String.format(
-                        "Parameter 'localName':'%s' contains illegal character '%s'", localName, c));
+                throw new IllegalArgumentException("Parameter 'localName':'" + localName
+                    + "' contains illegal character '" + c + "'");
             }
         }
         return localName;
@@ -170,18 +181,17 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
         // Identity comparison is here on purpose, as we are deciding whether to potentially store 'qname' into the
         // interner. It is important that it does not hold user-supplied reference (such a String instance from
         // parsing of an XML document).
-        final QName template = cacheMod == module ? this : QName.create(cacheMod, localName);
+        final QName template = cacheMod == module ? this : QName.create(cacheMod, localName.intern());
 
         return INTERNER.intern(template);
     }
 
     @Override
     public int hashCode() {
-        final int prime = 31;
-        int result = 1;
-        result = prime * result + Objects.hashCode(localName);
-        result = prime * result + module.hashCode();
-        return result;
+        if (hash == 0) {
+            hash = Objects.hash(module, localName);
+        }
+        return hash;
     }
 
     /**
@@ -240,7 +250,22 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
     }
 
     /**
+     * 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 String namespace, final String localName, final Date revision) {
+        final URI namespaceUri = parseNamespace(namespace);
+        return create(QNameModule.create(namespaceUri, revision), localName);
+    }
+
+    /**
      * Creates new QName.
      *
      * @param namespace
@@ -250,7 +275,7 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
      *            in format <code>YYYY-mm-dd</code>.
      * @param localName
      *            Local name part of QName. MUST NOT BE null.
-     * @return
+     * @return A new QName
      * @throws NullPointerException
      *             If any of parameters is null.
      * @throws IllegalArgumentException
@@ -268,7 +293,7 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
         try {
             return new URI(namespace);
         } catch (final URISyntaxException ue) {
-            throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
+            throw new IllegalArgumentException("Namespace '" + namespace + "' is not a valid URI", ue);
         }
     }
 
@@ -279,7 +304,7 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
      *            Namespace of QName, MUST NOT BE Null.
      * @param localName
      *            Local name part of QName. MUST NOT BE null.
-     * @return
+     * @return A new QName
      * @throws NullPointerException
      *             If any of parameters is null.
      * @throws IllegalArgumentException
@@ -321,6 +346,18 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
 
     /**
      * Creates copy of this with revision and prefix unset.
+     * Returns a QName with the specified QNameModule and the same localname as this one.
+     *
+     * @param newModule New QNameModule to use
+     * @return a QName with specified QNameModule and same local name as this one
+     */
+    public QName withModule(@Nonnull final QNameModule newModule) {
+        return new QName(newModule, localName);
+    }
+
+    /**
+     * 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.
      *
      * @return copy of this QName with revision and prefix unset.
      */
@@ -376,7 +413,7 @@ public final class QName implements Immutable, Serializable, Comparable<QName> {
     }
 
     @Override
-    public int compareTo(final QName other) {
+    public int compareTo(@Nonnull final QName other) {
         // compare mandatory localName parameter
         int result = localName.compareTo(other.localName);
         if (result != 0) {