common/concepts/src/main/java/org/opendaylight/yangtools/concepts/SemVer.java

   1 /*
   2  * Copyright (c) 2016 Pantheon Technologies s.r.o. 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.concepts;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.annotations.Beta;
  13 import java.io.Serializable;
  14 import java.util.Objects;
  15 import javax.annotation.Nonnull;
  16
  17 /**
  18  * A single version according to <a href="http://semver.org/">Semantic Versioning</a>.
  19  */
  20 @Beta
  21 public final class SemVer implements Comparable<SemVer>, Serializable {
  22     private static final long serialVersionUID = 1L;
  23     private final int major;
  24     private final int minor;
  25     private final int patch;
  26
  27     private SemVer(final int major, final int minor, final int patch) {
  28         checkArgument(major >= 0);
  29         this.major = major;
  30         checkArgument(minor >= 0);
  31         this.minor = minor;
  32         checkArgument(patch >= 0);
  33         this.patch = patch;
  34     }
  35
  36     public static SemVer create(final int major) {
  37         return create(major, 0);
  38     }
  39
  40     public static SemVer create(final int major, final int minor) {
  41         return create(major, minor, 0);
  42     }
  43
  44     public static SemVer create(final int major, final int minor, final int patch) {
  45         return new SemVer(major, minor, patch);
  46     }
  47
  48     public static SemVer valueOf(@Nonnull final String str) {
  49         final int minorIdx = str.indexOf('.');
  50         if (minorIdx == -1) {
  51             return create(Integer.parseInt(str));
  52         }
  53
  54         final String minorStr;
  55         final int patchIdx = str.indexOf('.', minorIdx + 1);
  56         if (patchIdx == -1) {
  57             minorStr = str.substring(minorIdx + 1);
  58             return create(Integer.parseInt(str.substring(0, minorIdx), 10), Integer.parseInt(minorStr, 10));
  59         }
  60
  61         minorStr = str.substring(minorIdx + 1, patchIdx);
  62         return create(Integer.parseInt(str.substring(0, minorIdx), 10), Integer.parseInt(minorStr, 10),
  63             Integer.parseInt(str.substring(patchIdx + 1), 10));
  64     }
  65
  66     /**
  67      * Return the major version number.
  68      *
  69      * @return major version number
  70      */
  71     public int getMajor() {
  72         return major;
  73     }
  74
  75     /**
  76      * Return the minor version number.
  77      *
  78      * @return minor version number
  79      */
  80     public int getMinor() {
  81         return minor;
  82     }
  83
  84     /**
  85      * Return the patch version number.
  86      *
  87      * @return patch version number
  88      */
  89     public int getPatch() {
  90         return patch;
  91     }
  92
  93     @Override
  94     public int compareTo(@Nonnull final SemVer other) {
  95         int cmp = Integer.compare(major, other.major);
  96         if (cmp == 0) {
  97             cmp = Integer.compare(minor, other.minor);
  98             if (cmp == 0) {
  99                 return Integer.compare(patch, other.patch);
 100             }
 101         }
 102
 103         return cmp;
 104     }
 105
 106     @Override
 107     public int hashCode() {
 108         return Objects.hash(major, minor, patch);
 109     }
 110
 111     @Override
 112     public boolean equals(final Object obj) {
 113         if (this == obj) {
 114             return true;
 115         }
 116         if (!(obj instanceof SemVer)) {
 117             return false;
 118         }
 119
 120         final SemVer o = (SemVer) obj;
 121         return major == o.major && minor == o.minor && patch == o.patch;
 122     }
 123
 124     @Override
 125     public String toString() {
 126         return major + "." + minor + "." + patch;
 127     }
 128 }