/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.Fpre
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
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.collect.Interner;
+import com.google.common.collect.Interners;
import java.io.Serializable;
import java.net.URI;
import java.net.URISyntaxException;
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;
-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
*
*/
public final class QName implements Immutable, Serializable, Comparable<QName> {
- private static final ObjectCache CACHE = ObjectCacheFactory.getObjectCache(QName.class);
+ private static final Interner<QName> INTERNER = Interners.newWeakInterner();
private static final long serialVersionUID = 5398411242927766414L;
static final String QNAME_REVISION_DELIMITER = "?revision=";
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);
+
+ @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);
- // Mandatory
+ 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);
this.module = module;
}
- /**
- * Look up specified QName in the global cache and return a shared reference.
- *
- * @param qname QName instance
- * @return Cached instance, according to {@link ObjectCache} policy.
- */
- public static QName cachedReference(final QName qname) {
- // We also want to make sure we keep the QNameModule cached
- final QNameModule myMod = qname.getModule();
- final QNameModule cacheMod = QNameModule.cachedReference(myMod);
-
- final QName what;
- if (cacheMod == myMod) {
- what = qname;
- } else {
- what = QName.create(cacheMod, qname.localName);
- }
-
- return CACHE.getReference(what);
- }
-
/**
* QName Constructor.
*
}
private static String checkLocalName(final String localName) {
- if (localName == null) {
- throw new IllegalArgumentException("Parameter 'localName' may not be null.");
- }
- if (localName.length() == 0) {
- throw new IllegalArgumentException("Parameter 'localName' must be a non-empty string.");
- }
+ Preconditions.checkArgument(localName != null, "Parameter 'localName' may not be null.");
+ 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;
return module.getRevision();
}
+ /**
+ * Return an interned reference to a equivalent QName.
+ *
+ * @return Interned reference, or this object if it was interned.
+ */
+ public QName intern() {
+ // We also want to make sure we keep the QNameModule cached
+ final QNameModule cacheMod = module.intern();
+
+ // 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.intern());
+
+ return INTERNER.intern(template);
+ }
+
@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;
+ if (hash == 0) {
+ hash = Objects.hash(module, localName);
+ }
+ return hash;
}
/**
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);
+ return Objects.equals(localName, other.localName) && module.equals(other.module);
}
public static QName create(final QName base, final String localName) {
* @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);
+ return new QName(Preconditions.checkNotNull(qnameModule,"module may not be null"), 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 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
* 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
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);
}
}
* 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
public String toString() {
final StringBuilder sb = new StringBuilder();
if (getNamespace() != null) {
- sb.append(QNAME_LEFT_PARENTHESIS + getNamespace());
+ sb.append(QNAME_LEFT_PARENTHESIS).append(getNamespace());
if (getFormattedRevision() != null) {
- sb.append(QNAME_REVISION_DELIMITER + getFormattedRevision());
+ sb.append(QNAME_REVISION_DELIMITER).append(getFormattedRevision());
}
sb.append(QNAME_RIGHT_PARENTHESIS);
}
/**
* 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.
*/
}
@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) {
Code Review / yangtools.git / blobdiff