Fold yang-model-util-ut

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / repo / api / SourceIdentifier.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java
index 7b9c29981e3ec1e904c3c6434cf117d97aee9f08..b6cb99f726fd4746def17562aed253c9e5267902 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SourceIdentifier.java
@@ -13,8 +13,11 @@ import com.google.common.annotations.Beta;
 import com.google.common.collect.Interner;
 import com.google.common.collect.Interners;
 import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.concepts.Identifier;
 import org.opendaylight.yangtools.concepts.Immutable;
+import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.common.YangConstants;
 
 /**
@@ -30,54 +33,40 @@ import org.opendaylight.yangtools.yang.common.YangConstants;
  */
 @Beta
 public abstract class SourceIdentifier implements Identifier, Immutable {
-    /**
-     * Default revision for sources without specified revision. This should be used for comparisons
-     * based on revision when a SourceIdentifier does not have a revision.
-     */
-    public static final String NOT_PRESENT_FORMATTED_REVISION = "0000-00-00";
-
     private static final Interner<SourceIdentifier> INTERNER = Interners.newWeakInterner();
+    private static final long serialVersionUID = 2L;
 
-    private static final long serialVersionUID = 1L;
-    private final String revision;
-    private final String name;
+    private final @Nullable Revision revision;
+    private final @NonNull String name;
 
     /**
      * Creates new YANG Schema source identifier for sources without revision.
      *
-     * @param name
-     *            Name of schema
+     * @param name Name of schema
      */
     SourceIdentifier(final String name) {
-        this.name = requireNonNull(name);
-        this.revision = null;
+        this(name, (Revision) null);
     }
 
     /**
      * Creates new YANG Schema source identifier.
      *
-     * @param name
-     *            Name of schema
-     * @param formattedRevision
-     *            Revision of source in format YYYY-mm-dd
+     * @param name Name of schema
+     * @param revision Revision of source, may be null
      */
-    SourceIdentifier(final String name, final String formattedRevision) {
+    SourceIdentifier(final String name, final @Nullable Revision revision) {
         this.name = requireNonNull(name);
-        this.revision = requireNonNull(formattedRevision);
+        this.revision = revision;
     }
 
     /**
      * Creates new YANG Schema source identifier.
      *
-     * @param name
-     *            Name of schema
-     * @param formattedRevision
-     *            Revision of source in format YYYY-mm-dd. If not present,
-     *            default value will be used.
+     * @param name Name of schema
+     * @param revision Revision of source, possibly not present
      */
-    SourceIdentifier(final String name, final Optional<String> formattedRevision) {
-        this.name = requireNonNull(name);
-        this.revision = formattedRevision.orElse(null);
+    SourceIdentifier(final String name, final Optional<Revision> revision) {
+        this(name, revision.orElse(null));
     }
 
     /**
@@ -85,7 +74,7 @@ public abstract class SourceIdentifier implements Identifier, Immutable {
      *
      * @return Interned reference, or this object if it was interned.
      */
-    public SourceIdentifier intern() {
+    public @NonNull SourceIdentifier intern() {
         return INTERNER.intern(this);
     }
 
@@ -94,7 +83,7 @@ public abstract class SourceIdentifier implements Identifier, Immutable {
      *
      * @return model name
      */
-    public String getName() {
+    public @NonNull String getName() {
         return name;
     }
 
@@ -103,26 +92,23 @@ public abstract class SourceIdentifier implements Identifier, Immutable {
      *
      * @return revision of source or null if revision was not supplied.
      */
-    // FIXME: version 2.0.0: this should return Optional<String>
-    public String getRevision() {
-        return revision;
+    public Optional<Revision> getRevision() {
+        return Optional.ofNullable(revision);
     }
 
     /**
      * Returns filename for this YANG module as specified in RFC 6020.
      *
      * <p>
-     * Returns filename in format <code>name ['@' revision] '.yang'</code>,
-     * where revision is date in format YYYY-mm-dd.
+     * Returns filename in format <code>name ['@' revision] '.yang'</code>, where revision is date in format YYYY-mm-dd.
      *
      * <p>
      * @see <a href="http://tools.ietf.org/html/rfc6020#section-5.2">RFC6020</a>
      *
      * @return Filename for this source identifier.
      */
-    public String toYangFilename() {
-        final String rev = NOT_PRESENT_FORMATTED_REVISION.equals(revision) ? null : revision;
-        return toYangFileName(name, Optional.ofNullable(rev));
+    public @NonNull String toYangFilename() {
+        return toYangFileName(name, Optional.ofNullable(revision));
     }
 
     /**
@@ -135,15 +121,15 @@ public abstract class SourceIdentifier implements Identifier, Immutable {
      * <p>
      * See http://tools.ietf.org/html/rfc6020#section-5.2
      *
+     * @param moduleName module name
+     * @param revision optional revision
      * @return Filename for this source identifier.
      */
-    public static String toYangFileName(final String moduleName, final Optional<String> revision) {
-        StringBuilder filename = new StringBuilder(moduleName);
+    public static @NonNull String toYangFileName(final String moduleName, final Optional<Revision> revision) {
+        final StringBuilder sb = new StringBuilder(moduleName);
         if (revision.isPresent()) {
-            filename.append('@');
-            filename.append(revision.get());
+            sb.append('@').append(revision.orElseThrow());
         }
-        filename.append(YangConstants.RFC6020_YANG_FILE_EXTENSION);
-        return filename.toString();
+        return sb.append(YangConstants.RFC6020_YANG_FILE_EXTENSION).toString();
     }
 }