Source: lib/deprecate/version.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.deprecate.Version');
  9. /**
  10.  * A class that defines what a library version is within the deprecation
  11.  * system. Within deprecation we only care about the major and minor versions.
  12.  *
  13.  * @final
  14.  */
  15. shaka.deprecate.Version = class {
  16.   /**
  17.    * @param {number} major
  18.    * @param {number} minor
  19.    */
  20.   constructor(major, minor) {
  21.     this.major_ = major;
  22.     this.minor_ = minor;
  23.   }
  25.   /** @return {number} */
  26.   major() { return this.major_; }
  28.   /** @return {number} */
  29.   minor() { return this.minor_; }
  31.   /**
  32.    * Returns:
  33.    *  - positive if |this| > |other|
  34.    *  - zero if |this| == |other|
  35.    *  - negative if |this| < |other|
  36.    *
  37.    * @param {!shaka.deprecate.Version} other
  38.    * @return {number}
  39.    */
  40.   compareTo(other) {
  41.     const majorCheck = this.major_ - other.major_;
  42.     const minorCheck = this.minor_ - other.minor_;
  44.     return majorCheck || minorCheck;
  45.   }
  47.   /** @override */
  48.   toString() {
  49.     return 'v' + this.major_ + '.' + this.minor_;
  50.   }
  52.   /**
  53.    * Parse the major and minor values out of a version string that is assumed
  54.    * to follow the grammar: "vMAJOR.MINOR.". What comes after the last "." we
  55.    * will ignore.
  56.    *
  57.    * @param {string} versionString
  58.    * @return {!shaka.deprecate.Version}
  59.    */
  60.   static parse(versionString) {
  61.     // Make sure to drop the "v" from the front. We limit the number of splits
  62.     // to two as we don't care what happens after the minor version number.
  63.     // For example: 'a.b.c.d'.split('.', 2) == ['a', 'b']
  64.     const components = versionString.substring(1).split('.', /* limit= */ 2);
  66.     return new shaka.deprecate.Version(
  67.         Number(components[0]),
  68.         Number(components[1]));
  69.   }
  70. };