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=d74786b910fabc6ad8efa51eabb6b9381928731d;hb=c4517068c0183a892703b26baf098c97bfb2a854;hp=39aaa9487b467d8c284afd9ebcbb979b2fbe39a7;hpb=8f2876d895936b36aba1fc3ec65b18900e559184;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 39aaa9487b..d74786b910 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,34 +7,33 @@ */ package org.opendaylight.yangtools.yang.common; -import static com.google.common.base.Preconditions.checkArgument; import static java.util.Objects.requireNonNull; -import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat; -import com.google.common.base.Strings; +import com.google.common.annotations.Beta; 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.text.ParseException; -import java.util.Date; +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 javax.annotation.Nonnull; -import javax.annotation.RegEx; -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. * *
- * QName may also have
+ * When in doubt, use {@link #create(QNameModule, String)} instead.
*
- * @return YANG schema identifier which were defined for this node in the
- * YANG module
+ * @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
*/
- public String getLocalName() {
- return localName;
+ @Beta
+ public static @NonNull QName unsafeOf(final @NonNull QNameModule qnameModule, final @NonNull String localName) {
+ return new QName(qnameModule, localName);
}
/**
- * Returns revision of the YANG module if the module has defined revision,
- * otherwise returns
- * YANG Specification defines format for
- * YANG Specification defines format for
- * Compares instance of this to other instance of QName and returns true if
- * both instances have equal 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, ComparableYYYY-mm-dd
.
- * @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 @NonNull QName create(final String namespace, final String localName, final Revision revision) {
+ return create(QNameModule.create(XMLNamespace.of(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}.
+ * @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 or
- * revision
is not according to format
- * YYYY-mm-dd
.
+ * @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 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);
+ public static @NonNull QName create(final String namespace, final String revision, final String localName) {
+ return create(XMLNamespace.of(namespace), Revision.of(revision), localName);
}
/**
* Creates new QName.
*
- * @param namespace
- * Namespace of QName, MUST NOT BE Null.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
+ * @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.
+ * @throws NullPointerException If any of parameters is null.
+ * @throws IllegalArgumentException If {@code namespace} is not valid URI.
*/
- public static QName create(final String namespace, final String localName) {
- return create(parseNamespace(namespace), null, localName);
+ public static @NonNull QName create(final String namespace, final String localName) {
+ return create(XMLNamespace.of(namespace), localName);
}
/**
- * Get the module component of the QName.
+ * Creates new QName.
*
- * @return Module component
+ * @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.
*/
- public QNameModule getModule() {
- return module;
+ public static @NonNull QName create(final XMLNamespace namespace, final String localName) {
+ return new QName(namespace, localName);
}
/**
- * Returns XMLNamespace assigned to the YANG module.
+ * Read a QName from a DataInput. The format is expected to match the output format of {@link #writeTo(DataOutput)}.
*
- * @return XMLNamespace assigned to the YANG module.
+ * @param in DataInput to read
+ * @return A QName instance
+ * @throws IOException if I/O error occurs
*/
- public URI getNamespace() {
- return module.getNamespace();
+ public static @NonNull QName readFrom(final DataInput in) throws IOException {
+ if (in instanceof QNameAwareDataInput) {
+ return ((QNameAwareDataInput) in).readQName();
+ }
+
+ 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.
+ * 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.
+ *
+ * null
.
+ * Get the module component of the QName.
*
- * @return revision of the YANG module if the module has defined revision,
- * otherwise returns null
+ * @return Module component
*/
- public Date getRevision() {
- return module.getRevision();
+ public @NonNull QNameModule getModule() {
+ return module;
+ }
+
+ /**
+ * Returns XMLNamespace assigned to the YANG module.
+ *
+ * @return XMLNamespace assigned to the YANG module.
+ */
+ public @NonNull XMLNamespace getNamespace() {
+ return module.getNamespace();
}
/**
- * Return an interned reference to a equivalent QName.
+ * Returns revision of the YANG module if the module has defined revision.
*
- * @return Interned reference, or this object if it was interned.
+ * @return revision of the YANG module if the module has defined revision.
*/
- public QName intern() {
+ public @NonNull OptionalYYYY-mm-dd
- *
- * revision
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 same namespace and local name, but with no revision. If this QName does not have
+ * a Revision, this object is returned.
*
- * @return String representation of revision or null, if revision is not
- * set.
+ * @return a QName with the same namespace and local name, but with no revision.
*/
- public String getFormattedRevision() {
- return module.getFormattedRevision();
+ public @NonNull QName withoutRevision() {
+ final QNameModule newModule;
+ return (newModule = module.withoutRevision()) == module ? this : new QName(newModule, getLocalName());
}
/**
- * Creates copy of this with revision and prefix unset.
- *
- * @return copy of this QName with revision and prefix unset.
- */
- public QName withoutRevision() {
- return create(getNamespace(), null, localName);
- }
-
- @SuppressWarnings("checkstyle:illegalCatch")
- 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);
- }
- }
-
- /**
- * Formats {@link Date} representing revision to format
- * YYYY-mm-dd
+ * Formats {@link Revision} representing revision to format {@code YYYY-mm-dd}
*
* revision
as
- * YYYY-mm-dd. This format for revision is reused accross multiple places
- * such as capabilities URI, YANG modules, etc.
+ * 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 OptionallocalName
({@link #getLocalName()}
- * ) and namespace
({@link #getNamespace()}).
+ * 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 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