*/
package org.opendaylight.yangtools.yang.common;
-import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat;
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.collect.Interner;
+import com.google.common.collect.Interners;
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
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.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+import javax.annotation.RegEx;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.concepts.Identifier;
import org.opendaylight.yangtools.concepts.Immutable;
-import org.opendaylight.yangtools.objcache.ObjectCache;
-import org.opendaylight.yangtools.objcache.ObjectCacheFactory;
+import org.opendaylight.yangtools.concepts.WritableObject;
/**
* The QName from XML consists of local name of element and XML namespace, but
* for our use, we added module revision to it.
*
+ * <p>
* 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
* node in the YANG module</li>
* </ul>
*
+ * <p>
* QName may also have <code>prefix</code> 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, Comparable<QName> {
- private static final ObjectCache CACHE = ObjectCacheFactory.getObjectCache(QName.class);
+@NonNullByDefault
+public final class QName implements Immutable, Serializable, Comparable<QName>, Identifier, WritableObject {
+ 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);
+
+ private static final char[] ILLEGAL_CHARACTERS = { '?', '(', ')', '&', ':' };
- // Mandatory
private final QNameModule module;
- // Mandatory
private final String localName;
+ private transient int hash = 0;
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.equals(myMod)) {
- what = qname;
- } else {
- what = QName.create(cacheMod, qname.localName);
- }
-
- return CACHE.getReference(what);
+ this.module = requireNonNull(module);
+ this.localName = requireNonNull(localName);
}
/**
* @param localName
* YANG schema identifier
*/
- public QName(final URI namespace, final String localName) {
- this(QNameModule.create(namespace, null), localName);
+ private QName(final URI namespace, final String localName) {
+ this(QNameModule.create(namespace), checkLocalName(localName));
}
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.");
- }
+ checkArgument(localName != null, "Parameter 'localName' may not be null.");
+ 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;
final String localName = matcher.group(2);
return new QName(namespace, localName);
}
- matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
- if (matcher.matches()) {
- final String localName = matcher.group(1);
- return new QName((URI) null, localName);
- }
- throw new IllegalArgumentException("Invalid input:" + input);
+ throw new IllegalArgumentException("Invalid input: " + input);
+ }
+
+ 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) {
+ return new QName(requireNonNull(qnameModule, "module may not be null"), checkLocalName(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 @Nullable Revision revision, final String localName) {
+ return create(QNameModule.create(namespace, revision), localName);
+ }
+
+ /**
+ * Creates new QName.
+ *
+ * @param namespace Namespace of QName or null if namespace is undefined.
+ * @param revision Revision of namespace.
+ * @param localName Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
+ */
+ public static QName create(final URI namespace, final Optional<Revision> revision, final String localName) {
+ return create(QNameModule.create(namespace, revision), 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 Revision revision) {
+ final URI namespaceUri = parseNamespace(namespace);
+ return create(QNameModule.create(namespaceUri, 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 <code>YYYY-mm-dd</code>.
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return A new QName
+ * @throws NullPointerException
+ * 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
+ * <code>YYYY-mm-dd</code>.
+ */
+ public static QName create(final String namespace, final String revision, final String localName) {
+ final URI namespaceUri = parseNamespace(namespace);
+ final Revision revisionDate = Revision.of(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 A new QName
+ * @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) {
+ return create(parseNamespace(namespace), 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 A new QName
+ * @throws NullPointerException If any of parameters is null.
+ * @throws IllegalArgumentException If <code>namespace</code> is not valid URI.
+ */
+ public static QName create(final URI namespace, final String localName) {
+ return new QName(namespace, localName);
+ }
+
+ /**
+ * Read a QName from a DataInput. The format is expected to match the output format of {@link #writeTo(DataOutput)}.
+ *
+ * @param in DataInput to read
+ * @return A QName instance
+ * @throws IOException if I/O error occurs
+ */
+ public static QName readFrom(final DataInput in) throws IOException {
+ final QNameModule module = QNameModule.readFrom(in);
+ return new QName(module, checkLocalName(in.readUTF()));
}
/**
/**
* Returns YANG schema identifier which were defined for this node in the
- * YANG module
+ * YANG module.
*
* @return YANG schema identifier which were defined for this node in the
* YANG module
}
/**
- * Returns revision of the YANG module if the module has defined revision,
- * otherwise returns <code>null</code>
+ * Returns revision of the YANG module if the module has defined revision.
*
- * @return revision of the YANG module if the module has defined revision,
- * otherwise returns <code>null</code>
+ * @return revision of the YANG module if the module has defined revision.
*/
- public Date getRevision() {
+ public Optional<Revision> getRevision() {
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 + Objects.hashCode(localName);
- result = prime * result + module.hashCode();
- return result;
+ if (hash == 0) {
+ hash = Objects.hash(module, localName);
+ }
+ return hash;
}
/**
- *
* Compares the specified object with this list for equality. Returns
* <tt>true</tt> if and only if the specified object is also instance of
* {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
*
*/
@Override
- public boolean equals(final Object obj) {
+ public boolean equals(final @Nullable Object obj) {
if (this == obj) {
return true;
}
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) {
- 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 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 <code>YYYY-mm-dd</code>.
- * @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 or
- * <code>revision</code> is not according to format
- * <code>YYYY-mm-dd</code>.
- */
- public static QName create(final String namespace, final String revision, final String localName) {
- final URI namespaceUri = parseNamespace(namespace);
- final Date revisionDate = parseRevision(revision);
- return create(namespaceUri, revisionDate, localName);
+ return Objects.equals(localName, other.localName) && module.equals(other.module);
}
private static URI parseNamespace(final String namespace) {
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);
}
}
- /**
- * 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) {
- return create(parseNamespace(namespace), null, localName);
- }
-
@Override
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());
+ final Optional<Revision> rev = getRevision();
+ if (rev.isPresent()) {
+ sb.append(QNAME_REVISION_DELIMITER).append(rev.get());
}
sb.append(QNAME_RIGHT_PARENTHESIS);
}
}
/**
- * Return string representation of revision in format
- * <code>YYYY-mm-dd</code>
- *
- * YANG Specification defines format for <code>revision</code> as
- * YYYY-mm-dd. This format for revision is reused accross multiple places
- * such as capabilities URI, YANG modules, etc.
+ * Returns a QName with the specified QNameModule and the same localname as this one.
*
- * @return String representation of revision or null, if revision is not
- * set.
+ * @param newModule New QNameModule to use
+ * @return a QName with specified QNameModule and same local name as this one
*/
- public String getFormattedRevision() {
- return module.getFormattedRevision();
+ public QName withModule(final QNameModule newModule) {
+ return new QName(newModule, localName);
}
/**
- * Creates copy of this with revision and prefix unset.
+ * 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 returned.
*
- * @return copy of this QName with revision and prefix unset.
+ * @return a QName with the same namespace and local name, but with no revision.
*/
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);
- }
+ return getRevision().isPresent() ? new QName(module.withoutRevision(), localName) : this;
}
/**
- * Formats {@link Date} representing revision to format
- * <code>YYYY-mm-dd</code>
+ * Formats {@link Revision} representing revision to format <code>YYYY-mm-dd</code>
*
+ * <p>
* YANG Specification defines format for <code>revision</code> 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
+ * Date object to format
* @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);
+ public static String formattedRevision(final Optional<Revision> revision) {
+ return revision.map(Revision::toString).orElse(null);
}
/**
- *
* Compares this QName to other, without comparing revision.
*
+ * <p>
* Compares instance of this to other instance of QName and returns true if
* both instances have equal <code>localName</code> ({@link #getLocalName()}
* ) and <code>namespace</code> ({@link #getNamespace()}).
return localName.equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
}
+ // FIXME: this comparison function looks odd. We are sorting first by local name and then by module? What is
+ // the impact on iteration order of SortedMap<QName, ?>?
@Override
- public int compareTo(final QName other) {
+ @SuppressWarnings("checkstyle:parameterName")
+ public int compareTo(final QName o) {
// compare mandatory localName parameter
- int result = localName.compareTo(other.localName);
+ int result = localName.compareTo(o.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;
+ return module.compareTo(o.module);
}
+ @Override
+ public void writeTo(final DataOutput out) throws IOException {
+ module.writeTo(out);
+ out.writeUTF(localName);
+ }
}
Code Review / yangtools.git / blobdiff