/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ * 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,
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.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
*
*/
public final class QName implements Immutable, Serializable, Comparable<QName> {
+ private static final ObjectCache CACHE = ObjectCacheFactory.getObjectCache(QName.class);
private static final long serialVersionUID = 5398411242927766414L;
static final String QNAME_REVISION_DELIMITER = "?revision=";
+ "(.+)\\)(.+)$");
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[] { '?', '(', ')', '&' };
// Mandatory
private final QNameModule module;
// Mandatory
private final String localName;
- // Nullable
- private final String prefix;
- private QName(final QNameModule module, final String prefix, final String localName) {
+ private QName(final QNameModule module, final String localName) {
this.localName = checkLocalName(localName);
- this.prefix = prefix;
this.module = module;
}
/**
- * QName Constructor.
- *
- * @param namespace
- * the namespace assigned to the YANG module
- * @param revision
- * the revision of the YANG module
- * @param prefix
- * locally defined prefix assigned to local name
- * @param localName
- * YANG schema identifier
+ * 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 QName(final URI namespace, final Date revision, final String prefix, final String localName) {
- this(QNameModule.create(namespace, revision), prefix, localName);
+ 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);
}
/**
* YANG schema identifier
*/
public QName(final URI namespace, final String localName) {
- this(namespace, null, "", localName);
+ this(QNameModule.create(namespace, null), localName);
}
private static String checkLocalName(final String localName) {
return localName;
}
- /**
- * QName Constructor.
- *
- * @param namespace
- * the namespace assigned to the YANG module
- * @param revision
- * the revision of the YANG module
- * @param localName
- * YANG schema identifier
- *
- * @deprecated Use {@link #create(URI, Date, String)} instead.
- */
- @Deprecated
- public QName(final URI namespace, final Date revision, final String localName) {
- this(QNameModule.create(namespace, revision), null, localName);
- }
-
- /**
- * Construct new QName which reuses namespace, revision and prefix from
- * base.
- *
- * @param base
- * @param localName
- * @deprecated Use {@link #create(QName, String)} instead.
- */
- @Deprecated
- public QName(final QName base, final String localName) {
- this(base.getNamespace(), base.getRevision(), base.getPrefix(), localName);
- }
-
- /**
- * @deprecated Use {@link #create(String)} instead. This implementation is
- * broken.
- */
- @Deprecated
- public QName(final String input) throws ParseException {
- final String nsAndRev = input.substring(input.indexOf("(") + 1, input.indexOf(")"));
- final Date revision;
- final URI namespace;
- if (nsAndRev.contains("?")) {
- String[] splitted = nsAndRev.split("\\?");
- namespace = URI.create(splitted[0]);
- revision = getRevisionFormat().parse(splitted[1]);
- } else {
- namespace = URI.create(nsAndRev);
- revision = null;
- }
-
- this.localName = checkLocalName(input.substring(input.indexOf(")") + 1));
- this.prefix = null;
- this.module = QNameModule.create(namespace, revision);
- }
-
public static QName create(final String input) {
Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
if (matcher.matches()) {
throw new IllegalArgumentException("Invalid input:" + input);
}
+ /**
+ * Get the module component of the QName.
+ *
+ * @return Module component
+ */
+ public QNameModule getModule() {
+ return module;
+ }
+
/**
* Returns XMLNamespace assigned to the YANG module.
*
return module.getRevision();
}
- /**
- * Returns locally defined prefix assigned to local name
- *
- * @return locally defined prefix assigned to local name
- */
- public String getPrefix() {
- return prefix;
- }
-
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((localName == null) ? 0 : localName.hashCode());
- result = prime * result + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
- result = prime * result + ((getFormattedRevision() == null) ? 0 : getFormattedRevision().hashCode());
+ result = prime * result + module.hashCode();
return result;
}
* {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
* {@link #getRevision()} are equals to same properties of this instance.
*
- * @param o the object to be compared for equality with this QName
+ * @param obj the object to be compared for equality with this QName
* @return <tt>true</tt> if the specified object is equal to this QName
*
*/
} else if (!localName.equals(other.localName)) {
return false;
}
- if (getNamespace() == null) {
- if (other.getNamespace() != null) {
- return false;
- }
- } else if (!getNamespace().equals(other.getNamespace())) {
- return false;
- }
- if (getFormattedRevision() == null) {
- if (other.getFormattedRevision() != null) {
- return false;
- }
- } else if (!getRevision().equals(other.getRevision())) {
- return false;
- }
- return true;
+ return module.equals(other.module);
}
public static QName create(final QName base, final String localName) {
- return new QName(base, 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.
+ * @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 new QName(QNameModule.create(namespace, revision), null,localName);
+ return create(QNameModule.create(namespace, revision), localName);
}
/**
* Local name part of QName. MUST NOT BE null.
* @return
* @throws NullPointerException
- * If any of paramaters is null.
+ * If any of parameters is null.
* @throws IllegalArgumentException
* If <code>namespace</code> is not valid URI or
* <code>revision</code> is not according to format
*/
public static QName create(final String namespace, final String revision, final String localName)
throws IllegalArgumentException {
- final URI namespaceUri;
+ final URI namespaceUri = parseNamespace(namespace);
+ final Date revisionDate = parseRevision(revision);
+ return create(namespaceUri, revisionDate, localName);
+ }
+
+ private static URI parseNamespace(final String namespace) {
try {
- namespaceUri = new URI(namespace);
+ return 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);
+ /**
+ * Creates new QName.
+ *
+ * @param namespace
+ * Namespace of QName, MUST NOT BE Null.
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return
+ * @throws NullPointerException
+ * If any of parameters is null.
+ * @throws IllegalArgumentException
+ * If <code>namespace</code> is not valid URI.
+ */
+ public static QName create(final String namespace, final String localName) throws IllegalArgumentException {
+ return create(parseNamespace(namespace), null, localName);
}
@Override
* @return copy of this QName with revision and prefix unset.
*/
public QName withoutRevision() {
- return QName.create(getNamespace(), null, localName);
+ return create(getNamespace(), null, localName);
}
public static Date parseRevision(final String formatedDate) {
Code Review / yangtools.git / blobdiff