X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-common%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fcommon%2FQName.java;h=f70a736217a554bb2271dbcf4b2f507c07746473;hb=c7e8081901536d97a12b141cbb538f70c7a93d61;hp=46dfbc6242edbd82198fa8be1879fe8b6e04deff;hpb=3e0b6245313682a974e16b83b45aa146cd1a7e03;p=yangtools.git diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java index 46dfbc6242..f70a736217 100644 --- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java +++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java @@ -7,27 +7,35 @@ */ package org.opendaylight.yangtools.yang.common; -import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat; - -import java.io.Serializable; +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.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 org.opendaylight.yangtools.concepts.Immutable; +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. + * + *
+ * 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. + *
+ * The local name must conform to RFC7950 Section 6.2. * *
prefix
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, Comparablenull
+ * Creates new QName.
*
- * @return revision of the YANG module if the module has defined revision,
- * otherwise returns 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 Date getRevision() {
- return module.getRevision();
+ public static @NonNull QName create(final String namespace, final String localName, final Revision revision) {
+ return create(QNameModule.create(parseNamespace(namespace), revision), localName);
}
/**
- * Returns locally defined prefix assigned to local name
- *
- * @return locally defined prefix assigned to local name
+ * Creates new QName.
*
- * @deprecated Prefix storage in QNames is deprecated.
+ * @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}.
*/
- @Deprecated
- public String getPrefix() {
- return prefix;
+ public static @NonNull QName create(final String namespace, final String revision, final String localName) {
+ return create(parseNamespace(namespace), Revision.of(revision), localName);
}
- @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;
+ /**
+ * 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} is not valid URI.
+ */
+ public static @NonNull QName create(final String namespace, final String localName) {
+ return create(parseNamespace(namespace), localName);
}
/**
+ * Creates new QName.
*
- * Compares the specified object with this list for equality. Returns
- * 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 o the object to be compared for equality with this QName
- * @return true if the specified object is equal to this 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 namespace
is not valid URI.
*/
- @Override
- public boolean equals(final Object obj) {
- if (this == obj) {
- return true;
- }
- if (!(obj instanceof QName)) {
- 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 @NonNull QName create(final URI namespace, final String localName) {
+ return new QName(namespace, localName);
}
- public static QName create(final QName base, final String localName) {
- return new QName(base.getModule(), base.getPrefix(), 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 @NonNull QName readFrom(final DataInput in) throws IOException {
+ final QNameModule module = QNameModule.readFrom(in);
+ return new QName(module, checkLocalName(in.readUTF()));
}
/**
- * Creates new QName.
+ * 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.
*
- * @param qnameModule
- * Namespace and revision enclosed as a QNameModule
- * @param prefix
- * Namespace prefix
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return Instance of QName
+ *
+ * When in doubt, use {@link #create(QNameModule, String)} instead.
*
- * @deprecated Prefix storage in QNames is deprecated.
+ * @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
*/
- @Deprecated
- public static QName create(final QNameModule module, final String prefix, final String localName) {
- if (module == null) {
- throw new NullPointerException("module may not be null");
- }
- return new QName(module, prefix, localName);
+ @Beta
+ public static @NonNull QName unsafeOf(final @NonNull QNameModule qnameModule, final @NonNull String localName) {
+ return new QName(qnameModule, localName);
}
/**
- * Creates new QName.
+ * Get the module component of the 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
+ * @return Module component
*/
- public static QName create(final QNameModule qnameModule, final String localName) {
- return new QName(qnameModule, null, localName);
+ public @NonNull QNameModule getModule() {
+ return module;
}
/**
- * Creates new QName.
+ * Returns XMLNamespace assigned to the YANG module.
*
- * @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
+ * @return XMLNamespace assigned to the YANG module.
*/
- public static QName create(final URI namespace, final Date revision, final String localName) {
- return new QName(QNameModule.create(namespace, revision), null, localName);
+ public @NonNull URI getNamespace() {
+ return module.getNamespace();
}
/**
+ * Returns revision of the YANG module if the module has defined revision.
*
- * 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
+ * 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 or null
+ * @param revision 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 @Nullable String formattedRevision(final Optional
+ * 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 YYYY-mm-dd
.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return
- * @throws NullPointerException
- * If any of paramaters is null.
- * @throws IllegalArgumentException
- * If namespace
is not valid URI or
- * revision
is not according to format
- * YYYY-mm-dd
.
+ * @return revision of the YANG module if the module has defined revision.
*/
- public static QName create(final String namespace, final String revision, final String localName)
- throws IllegalArgumentException {
- final URI namespaceUri;
- try {
- namespaceUri = new URI(namespace);
- } catch (URISyntaxException ue) {
- throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
- }
+ public @NonNull OptionalYYYY-mm-dd
- *
- * YANG Specification defines format for revision
as
- * YYYY-mm-dd. This format for revision is reused accross multiple places
- * such as capabilities URI, YANG modules, etc.
+ * 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.
*
- * @return String representation of revision or null, if revision is not
- * set.
+ * @param obj the object to be compared for equality with this QName
+ * @return {@code true} if the specified object is equal to this QName
*/
- public String getFormattedRevision() {
- return module.getFormattedRevision();
+ @Override
+ public boolean equals(final Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!(obj instanceof QName)) {
+ return false;
+ }
+ final QName other = (QName) obj;
+ return Objects.equals(getLocalName(), other.getLocalName()) && module.equals(other.module);
}
- /**
- * Creates copy of this with revision and prefix unset.
- *
- * @return copy of this QName with revision and prefix unset.
- */
- public QName withoutRevision() {
- return QName.create(getNamespace(), null, localName);
+ private static @NonNull URI parseNamespace(final String namespace) {
+ try {
+ return new URI(namespace);
+ } catch (final URISyntaxException ue) {
+ throw new IllegalArgumentException("Namespace '" + namespace + "' is not a valid URI", ue);
+ }
}
- 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);
+ @Override
+ public @NonNull String toString() {
+ final StringBuilder sb = new StringBuilder().append(QNAME_LEFT_PARENTHESIS).append(getNamespace());
+ final OptionalYYYY-mm-dd
+ * Formats {@link Revision} representing revision to format {@code YYYY-mm-dd}
*
- * YANG Specification defines format for revision
as
- * YYYY-mm-dd. This format for revision is reused accross multiple places
- * such as capabilities URI, YANG modules, etc.
+ * localName
({@link #getLocalName()}
- * ) and namespace
({@link #getNamespace()}).
+ * other
is null.
+ * @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(getNamespace(), 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