*/
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.text.ParseException;
-import java.util.Date;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+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.util.Objects;
+import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-
-import org.opendaylight.yangtools.concepts.Immutable;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.checkerframework.checker.regex.qual.Regex;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
/**
- * The QName from XML consists of local name of element and XML namespace, but
- * for our use, we added module revision to it.
+ * 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 same local
+ * name, but from different schemas.
*
- * 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
- * same local name, but from different schemas.
+ * <p>
+ * The local name must conform to <a href="https://tools.ietf.org/html/rfc7950#section-6.2">RFC7950 Section 6.2</a>.
*
* <ul>
- * <li><b>XMLNamespace</b> - the namespace assigned to the YANG module which
+ * <li><b>XMLNamespace</b> - {@link #getNamespace()} - the namespace assigned to the YANG module which
* defined element, type, procedure or notification.</li>
- * <li><b>Revision</b> - the revision of the YANG module which describes the
+ * <li><b>Revision</b> - {@link #getRevision()} - the revision of the YANG module which describes the
* element</li>
- * <li><b>LocalName</b> - the YANG schema identifier which were defined for this
+ * <li><b>LocalName</b> - {@link #getLocalName()} - the YANG schema identifier which were defined for this
* node in the YANG module</li>
* </ul>
- *
- *
*/
-public final class QName implements Immutable, Serializable, Comparable<QName> {
- private static final long serialVersionUID = 5398411242927766414L;
- private static final Logger LOGGER = LoggerFactory.getLogger(QName.class);
-
- 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[] {'?', '(', ')', '&'};
-
- //Nullable
- private final URI namespace;
- //Mandatory
- private final String localName;
- //Nullable
- private final String prefix;
- //Nullable
- private final String formattedRevision;
- //Nullable
- private final Date revision;
-
+public final class QName extends AbstractQName implements Comparable<QName> {
/**
- * 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
+ * A {@link DataInput} which has an understanding of {@link QName}'s semantics.
*/
- public QName(final URI namespace, final Date revision, final String prefix, final String localName) {
- this.localName = checkLocalName(localName);
- this.namespace = namespace;
- this.revision = revision;
- this.prefix = prefix;
- if(revision != null) {
- this.formattedRevision = getRevisionFormat().format(revision);
- } else {
- this.formattedRevision = null;
- }
+ @Beta
+ public interface QNameAwareDataInput extends DataInput {
+ /**
+ * Read a {@link QName} from the stream.
+ *
+ * @return A QName
+ * @throws IOException if an I/O error occurs.
+ */
+ @NonNull QName readQName() throws IOException;
+ }
+
+ @Beta
+ public interface QNameAwareDataOutput extends DataOutput {
+ /**
+ * Write a {@link QName} into the stream.
+ *
+ * @param qname A QName
+ * @throws IOException if an I/O error occurs.
+ */
+ void writeQName(@NonNull QName qname) throws IOException;
+ }
+
+ private static final Interner<QName> INTERNER = Interners.newWeakInterner();
+ // Note: 5398411242927766414L is used for versions < 3.0.0 without writeReplace
+ private static final long serialVersionUID = 1L;
+
+ @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 final @NonNull QNameModule module;
+ private transient int hash = 0;
+
+ QName(final QNameModule module, final @NonNull String localName) {
+ super(localName);
+ this.module = requireNonNull(module);
}
/**
* @param localName
* YANG schema identifier
*/
- public QName(final URI namespace, final String localName) {
- this(namespace, null, "", localName);
+ private QName(final XMLNamespace 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.");
+ public static @NonNull QName create(final String input) {
+ Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
+ if (matcher.matches()) {
+ final String namespace = matcher.group(1);
+ final String revision = matcher.group(2);
+ final String localName = matcher.group(3);
+ return create(namespace, revision, localName);
}
- if (localName.length() == 0) {
- throw new IllegalArgumentException("Parameter 'localName' must be a non-empty string.");
+ matcher = QNAME_PATTERN_NO_REVISION.matcher(input);
+ if (matcher.matches()) {
+ final XMLNamespace namespace = XMLNamespace.of(matcher.group(1));
+ final String localName = matcher.group(2);
+ return new QName(namespace, localName);
}
+ throw new IllegalArgumentException("Invalid input: " + input);
+ }
- for (char c: ILLEGAL_CHARACTERS) {
- if (localName.indexOf(c) != -1) {
- throw new IllegalArgumentException(String.format(
- "Parameter 'localName':'%s' contains illegal character '%s'",
- localName, c));
- }
- }
- return localName;
+ public static @NonNull QName create(final QName base, final String localName) {
+ return create(base.getModule(), localName);
}
/**
- * QName Constructor.
+ * Creates new QName.
*
- * @param namespace
- * the namespace assigned to the YANG module
- * @param revision
- * the revision of the YANG module
- * @param localName
- * YANG schema identifier
+ * @param qnameModule Namespace and revision enclosed as a QNameModule
+ * @param localName Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
+ * @throws NullPointerException if any argument is null
+ * @throws IllegalArgumentException if localName is not a valid YANG identifier
*/
- public QName(final URI namespace, final Date revision, final String localName) {
- this(namespace, revision, null, localName);
+ public static @NonNull QName create(final QNameModule qnameModule, final String localName) {
+ return new QName(requireNonNull(qnameModule, "module may not be null"), checkLocalName(localName));
}
- public QName(final QName base, final String localName) {
- this(base.getNamespace(), base.getRevision(), base.getPrefix(), 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 @NonNull QName create(final XMLNamespace namespace, final @Nullable Revision revision,
+ final String localName) {
+ return create(QNameModule.create(namespace, revision), localName);
}
/**
- * @deprecated Use {@link #create(String)} instead.
- * This implementation is broken.
+ * 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
*/
- @Deprecated
- public QName(final String input) throws ParseException {
- Date revision = null;
- String nsAndRev = input.substring(input.indexOf("(") + 1, input.indexOf(")"));
- if (nsAndRev.contains("?")) {
- String[] splitted = nsAndRev.split("\\?");
- this.namespace = URI.create(splitted[0]);
- revision = getRevisionFormat().parse(splitted[1]);
- } else {
- this.namespace = URI.create(nsAndRev);
- }
-
- this.localName = checkLocalName(input.substring(input.indexOf(")") + 1));
- this.revision = revision;
- this.prefix = null;
- if (revision != null) {
- this.formattedRevision = getRevisionFormat().format(revision);
- } else {
- this.formattedRevision = null;
- }
+ public static @NonNull QName create(final XMLNamespace namespace, final Optional<Revision> revision,
+ final String localName) {
+ return create(QNameModule.create(namespace, revision), localName);
}
- public static QName create(final String input) {
- Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
- if (matcher.matches()) {
- String namespace = matcher.group(1);
- String revision = matcher.group(2);
- String localName = matcher.group(3);
- return create(namespace, revision, localName);
- }
- matcher = QNAME_PATTERN_NO_REVISION.matcher(input);
- if (matcher.matches()) {
- URI namespace = URI.create(matcher.group(1));
- String localName = matcher.group(2);
- return new QName(namespace, localName);
- }
- matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
- if (matcher.matches()) {
- String localName = matcher.group(1);
- return new QName((URI)null, localName);
- }
- throw new IllegalArgumentException("Invalid input:" + input);
+ /**
+ * 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 @NonNull QName create(final String namespace, final String localName, final Revision revision) {
+ return create(QNameModule.create(XMLNamespace.of(namespace), revision), localName);
}
/**
- * Returns XMLNamespace assigned to the YANG module.
+ * Creates new QName.
*
- * @return XMLNamespace assigned to the YANG module.
+ * @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}.
+ * @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} is not valid URI or {@code revision} does not conform
+ * to {@code YYYY-mm-dd}.
*/
- public URI getNamespace() {
- return namespace;
+ public static @NonNull QName create(final String namespace, final String revision, final String localName) {
+ return create(XMLNamespace.of(namespace), Revision.of(revision), localName);
}
/**
- * Returns YANG schema identifier which were defined for this node in the
- * YANG module
+ * Creates new QName.
*
- * @return YANG schema identifier which were defined for this node in the
- * YANG module
+ * @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} is not valid URI.
*/
- public String getLocalName() {
- return localName;
+ public static @NonNull QName create(final String namespace, final String localName) {
+ return create(XMLNamespace.of(namespace), localName);
}
/**
- * Returns revision of the YANG module if the module has defined revision,
- * otherwise returns <code>null</code>
+ * Creates new QName.
*
- * @return revision of the YANG module if the module has defined revision,
- * otherwise returns <code>null</code>
+ * @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 Date getRevision() {
- return revision;
+ public static @NonNull QName create(final XMLNamespace namespace, final String localName) {
+ return new QName(namespace, localName);
}
/**
- * Returns locally defined prefix assigned to local name
+ * Read a QName from a DataInput. The format is expected to match the output format of {@link #writeTo(DataOutput)}.
*
- * @return locally defined prefix assigned to local name
+ * @param in DataInput to read
+ * @return A QName instance
+ * @throws IOException if I/O error occurs
*/
- public String getPrefix() {
- return prefix;
- }
+ public static @NonNull QName readFrom(final DataInput in) throws IOException {
+ if (in instanceof QNameAwareDataInput) {
+ return ((QNameAwareDataInput) in).readQName();
+ }
- @Override
- public int hashCode() {
- final int prime = 31;
- int result = 1;
- result = prime * result + ((localName == null) ? 0 : localName.hashCode());
- result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
- result = prime * result + ((formattedRevision == null) ? 0 : formattedRevision.hashCode());
- return result;
+ final QNameModule module = QNameModule.readFrom(in);
+ return new QName(module, checkLocalName(in.readUTF()));
}
- @Override
- public boolean equals(final Object obj) {
- if (this == obj) {
- return true;
- }
- if (obj == null) {
- return false;
- }
- if (getClass() != obj.getClass()) {
- return false;
- }
- QName other = (QName) obj;
- if (localName == null) {
- if (other.localName != null) {
- return false;
- }
- } else if (!localName.equals(other.localName)) {
- return false;
- }
- if (namespace == null) {
- if (other.namespace != null) {
- return false;
- }
- } else if (!namespace.equals(other.namespace)) {
- return false;
- }
- if (formattedRevision == null) {
- if (other.formattedRevision != null) {
- return false;
- }
- } else if (!revision.equals(other.revision)) {
- return false;
- }
- return true;
+ /**
+ * Creates new QName composed of specified module and local name. This method does not perform lexical checking of
+ * localName, and it is the caller's responsibility to performs these checks.
+ *
+ * <p>
+ * When in doubt, use {@link #create(QNameModule, String)} instead.
+ *
+ * @param qnameModule Namespace and revision enclosed as a QNameModule
+ * @param localName Local name part of QName, required to have been validated
+ * @return Instance of QName
+ * @throws NullPointerException if any of the arguments is null
+ */
+ @Beta
+ public static @NonNull QName unsafeOf(final @NonNull QNameModule qnameModule, final @NonNull String localName) {
+ return new QName(qnameModule, localName);
}
+ /**
+ * Get the module component of the QName.
+ *
+ * @return Module component
+ */
+ public @NonNull QNameModule getModule() {
+ return module;
+ }
- public static QName create(final QName base, final String localName){
- return new QName(base, localName);
+ /**
+ * Returns XMLNamespace assigned to the YANG module.
+ *
+ * @return XMLNamespace assigned to the YANG module.
+ */
+ public @NonNull XMLNamespace getNamespace() {
+ return module.getNamespace();
}
- public static QName create(final URI namespace, final Date revision, final String localName){
- return new QName(namespace, revision, localName);
+ /**
+ * Returns revision of the YANG module if the module has defined revision.
+ *
+ * @return revision of the YANG module if the module has defined revision.
+ */
+ public @NonNull Optional<Revision> getRevision() {
+ return module.getRevision();
}
+ @Override
+ public @NonNull 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 : new QName(cacheMod, getLocalName().intern());
- public static QName create(final String namespace, final String revision, final String localName) throws IllegalArgumentException{
- try {
- URI namespaceUri = new URI(namespace);
- Date revisionDate = parseRevision(revision);
- return create(namespaceUri, revisionDate, localName);
- } catch (URISyntaxException ue) {
- throw new IllegalArgumentException("Namespace is is not valid URI", ue);
- }
+ return INTERNER.intern(template);
}
@Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- if (namespace != null) {
- sb.append(QNAME_LEFT_PARENTHESIS + namespace);
-
- if (formattedRevision != null) {
- sb.append(QNAME_REVISION_DELIMITER + formattedRevision);
- }
- sb.append(QNAME_RIGHT_PARENTHESIS);
+ public int hashCode() {
+ if (hash == 0) {
+ hash = Objects.hash(module, getLocalName());
}
- sb.append(localName);
- return sb.toString();
+ return hash;
}
/**
- * Returns a namespace in form defined by section 5.6.4. of {@link https
- * ://tools.ietf.org/html/rfc6020}, if namespace is not correctly defined,
- * the method will return <code>null</code> <br>
- * example "http://example.acme.com/system?revision=2008-04-01"
- *
- * @return namespace in form defined by section 5.6.4. of {@link https
- * ://tools.ietf.org/html/rfc6020}, if namespace is not correctly
- * defined, the method will return <code>null</code>
+ * Compares the specified object with this list for equality. Returns {@code true} if and only if the specified
+ * object is also instance of {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
+ * {@link #getRevision()} are equals to same properties of this instance.
*
+ * @param obj the object to be compared for equality with this QName
+ * @return {@code true} if the specified object is equal to this QName
*/
- URI getRevisionNamespace() {
-
- if (namespace == null) {
- return null;
- }
-
- String query = "";
- if (revision != null) {
- query = "revision=" + formattedRevision;
+ @Override
+ public boolean equals(final Object obj) {
+ if (this == obj) {
+ return true;
}
-
- URI compositeURI = null;
- try {
- compositeURI = new URI(namespace.getScheme(), namespace.getUserInfo(), namespace.getHost(),
- namespace.getPort(), namespace.getPath(), query, namespace.getFragment());
- } catch (URISyntaxException e) {
- LOGGER.error("", e);
+ if (!(obj instanceof QName)) {
+ return false;
}
- return compositeURI;
+ final QName other = (QName) obj;
+ return Objects.equals(getLocalName(), other.getLocalName()) && module.equals(other.module);
}
- public String getFormattedRevision() {
- return formattedRevision;
+ @Override
+ public @NonNull String toString() {
+ final StringBuilder sb = new StringBuilder().append('(').append(getNamespace());
+ final Optional<Revision> rev = getRevision();
+ if (rev.isPresent()) {
+ sb.append("?revision=").append(rev.get());
+ }
+ return sb.append(')').append(getLocalName()).toString();
}
- public QName withoutRevision() {
- return QName.create(namespace, null, localName);
+ @Override
+ public @NonNull QName bindTo(final QNameModule namespace) {
+ return module.equals(namespace) ? this : super.bindTo(namespace);
}
- public static Date parseRevision(final String formatedDate) {
- try {
- return getRevisionFormat().parse(formatedDate);
- } catch (ParseException| RuntimeException e) {
- throw new IllegalArgumentException("Revision is not in supported format:" + formatedDate,e);
- }
+ /**
+ * 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 a QName with the same namespace and local name, but with no revision.
+ */
+ public @NonNull QName withoutRevision() {
+ final QNameModule newModule;
+ return (newModule = module.withoutRevision()) == module ? this : new QName(newModule, getLocalName());
}
- public static String formattedRevision(final Date revision) {
- if(revision == null) {
- return null;
- }
- return getRevisionFormat().format(revision);
+ /**
+ * Formats {@link Revision} representing revision to format {@code YYYY-mm-dd}
+ *
+ * <p>
+ * YANG Specification defines format for {@code revision<} as YYYY-mm-dd. This format for revision is reused across
+ * multiple places such as capabilities URI, YANG modules, etc.
+ *
+ * @param revision Date object to format
+ * @return String representation or null if the input was null.
+ */
+ public static @Nullable 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} ({@link #getLocalName()}) and @{code namespace} ({@link #getNamespace()}).
+ *
+ * @param other Other QName. Must not be null.
+ * @return true if this instance and other have equals localName and namespace.
+ * @throws NullPointerException if {@code other} is null.
+ */
public boolean isEqualWithoutRevision(final QName other) {
- return localName.equals(other.getLocalName()) && Objects.equals(namespace, other.getNamespace());
+ return getLocalName().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 = getLocalName().compareTo(o.getLocalName());
if (result != 0) {
return result;
}
+ return module.compareTo(o.module);
+ }
- // compare nullable namespace parameter
- if (namespace == null) {
- if (other.namespace != null) {
- return -1;
- }
- } else {
- if (other.namespace == null) {
- return 1;
- }
- result = namespace.compareTo(other.namespace);
- if (result != 0) {
- return result;
- }
- }
-
- // compare nullable revision parameter
- if (revision == null) {
- if (other.revision != null) {
- return -1;
- }
+ @Override
+ public void writeTo(final DataOutput out) throws IOException {
+ if (out instanceof QNameAwareDataOutput) {
+ ((QNameAwareDataOutput) out).writeQName(this);
} else {
- if (other.revision == null) {
- return 1;
- }
- result = revision.compareTo(other.revision);
- if (result != 0) {
- return result;
- }
+ module.writeTo(out);
+ out.writeUTF(getLocalName());
}
-
- return result;
}
+ @Override
+ Object writeReplace() {
+ return new QNv1(this);
+ }
}
Code Review / yangtools.git / blobdiff