yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SemVerSourceIdentifier.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.repo.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Objects;
  12 import java.util.Optional;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.yangtools.concepts.SemVer;
  16 import org.opendaylight.yangtools.yang.common.Revision;
  17
  18 /**
  19  * YANG Schema source identifier with specified semantic version.
  20  *
  21  * <p>
  22  * Simple transfer object represents identifier of source for YANG schema (module or submodule), which consists of
  23  * <ul>
  24  * <li>YANG schema name {@link #getName()}
  25  * <li>Semantic version of yang schema {@link #getSemanticVersion()}
  26  * <li>(Optional) Module revision ({link {@link #getRevision()}
  27  * </ul>
  28  *
  29  * <p>
  30  * Source identifier is designated to be carry only necessary information to look-up YANG model source and to be used
  31  * by various SchemaSourceProviders.
  32  *
  33  * <p>
  34  * <b>Note:</b>On source retrieval layer it is impossible to distinguish between YANG module and/or submodule unless
  35  * source is present.
  36  *
  37  * <p>
  38  * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2
  39  * and http://tools.ietf.org/html/rfc6022#section-3.1 ).
  40  */
  41 @Beta
  42 @Deprecated(since = "7.0.11", forRemoval = true)
  43 public final class SemVerSourceIdentifier extends SourceIdentifier {
  44     private static final long serialVersionUID = 1L;
  45     private final SemVer semVer;
  46
  47     /**
  48      * Creates new YANG Schema semVer source identifier.
  49      *
  50      * @param name Name of schema
  51      * @param revision Revision of source, possibly not present
  52      * @param semVer semantic version of source
  53      */
  54     SemVerSourceIdentifier(final String name, final Optional<Revision> revision, final @Nullable SemVer semVer) {
  55         super(name, revision);
  56         this.semVer = semVer;
  57     }
  58
  59     /**
  60      * Creates new YANG Schema semVer source identifier.
  61      *
  62      * @param name Name of schema
  63      * @param semVer semantic version of source
  64      */
  65     SemVerSourceIdentifier(final String name, final @Nullable SemVer semVer) {
  66         this(name, Optional.empty(), semVer);
  67     }
  68
  69     /**
  70      * Returns semantic version of source if it was specified.
  71      *
  72      * @return revision of source.
  73      */
  74     public Optional<SemVer> getSemanticVersion() {
  75         return Optional.ofNullable(semVer);
  76     }
  77
  78     /**
  79      * Creates new YANG Schema semVer source identifier.
  80      *
  81      * @param moduleName Name of schema
  82      * @param semVer semantic version of source
  83      * @return A SemVerSourceIdentifier
  84      */
  85     public static @NonNull SemVerSourceIdentifier create(final String moduleName, final SemVer semVer) {
  86         return new SemVerSourceIdentifier(moduleName, semVer);
  87     }
  88
  89     /**
  90      * Creates new YANG Schema semVer source identifier.
  91      *
  92      * @param moduleName Name of schema
  93      * @param revision Revision of source in format YYYY-mm-dd
  94      * @param semVer semantic version of source
  95      * @return A SemVerSourceIdentifier
  96      */
  97     public static @NonNull SemVerSourceIdentifier create(final String moduleName, final Revision revision,
  98             final SemVer semVer) {
  99         return new SemVerSourceIdentifier(moduleName, Optional.ofNullable(revision), semVer);
 100     }
 101
 102     /**
 103      * Creates new YANG Schema semVer source identifier.
 104      *
 105      * @param moduleName Name of schema
 106      * @param revision Optional of source revision in format YYYY-mm-dd. If not present, default value will be used.
 107      * @param semVer semantic version of source
 108      * @return A SemVerSourceIdentifier
 109      */
 110     public static @NonNull SemVerSourceIdentifier create(final String moduleName, final Optional<Revision> revision,
 111             final SemVer semVer) {
 112         return new SemVerSourceIdentifier(moduleName, revision, semVer);
 113     }
 114
 115     @Override
 116     public int hashCode() {
 117         final int prime = 31;
 118         int result = 1;
 119         result = prime * result + Objects.hashCode(getName());
 120         result = prime * result + Objects.hashCode(semVer);
 121         return result;
 122     }
 123
 124     @Override
 125     public boolean equals(final Object obj) {
 126         if (this == obj) {
 127             return true;
 128         }
 129         if (!(obj instanceof SemVerSourceIdentifier)) {
 130             return false;
 131         }
 132         final SemVerSourceIdentifier other = (SemVerSourceIdentifier) obj;
 133         return Objects.equals(getName(), other.getName()) && Objects.equals(semVer, other.semVer);
 134     }
 135
 136     @Override
 137     public String toString() {
 138         return "SemVerSourceIdentifier [name=" + getName() + "(" + semVer + ")" + "@" + getRevision() + "]";
 139     }
 140 }