modules/cldc-compact/src/main/java/cc/squirreljme/jvm/suite/SuiteVersion.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jvm.suite;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Exported;
  13 import java.lang.ref.Reference;
  14 import java.lang.ref.WeakReference;
  15
  16 /**
  17  * This represents a suite version.
  18  *
  19  * @since 2016/10/12
  20  */
  21 @Exported
  22 public final class SuiteVersion
  23         implements Comparable<SuiteVersion>
  24 {
  25         /** The minimum version number. */
  26         @Exported
  27         public static final SuiteVersion MIN_VERSION =
  28                 new SuiteVersion(0, 0, 0);
  29
  30         /** The maximum version number. */
  31         @Exported
  32         public static final SuiteVersion MAX_VERSION =
  33                 new SuiteVersion(99, 99, 99);
  34
  35         /** The major version. */
  36         protected final int major;
  37
  38         /** The minor version. */
  39         protected final int minor;
  40
  41         /** The release version. */
  42         protected final int release;
  43
  44         /** The string representation. */
  45         private Reference<String> _string;
  46
  47         /**
  48          * Initializes the version.
  49          *
  50          * @param __v The value to parse.
  51          * @throws InvalidSuiteException If there are too many or too little
  52          * version fields, they contain illegal charactes, or have an out of range
  53          * value.
  54          * @throws NullPointerException On null arguments.
  55          * @since 2016/10/12
  56          */
  57         @Exported
  58         public SuiteVersion(String __v)
  59                 throws InvalidSuiteException, NullPointerException
  60         {
  61                 this(SuiteVersion.__decodeVersion(__v));
  62         }
  63
  64         /**
  65          * Initializes a Midlet version number from the specified array of
  66          * integer values.
  67          *
  68          * @param __v The version triplet, up to the first three elements are
  69          * used by the version number.
  70          * @throws InvalidSuiteException If the version number has an out of
  71          * range value.
  72          * @throws NullPointerException On null arguments.
  73          * @since 2016/10/12
  74          */
  75         @Exported
  76         public SuiteVersion(int[] __v)
  77                 throws InvalidSuiteException, NullPointerException
  78         {
  79                 this((__v.length > 0 ? __v[0] : 0),
  80                         (__v.length > 1 ? __v[1] : 0),
  81                         (__v.length > 2 ? __v[2] : 0));
  82         }
  83
  84         /**
  85          * Decodes the midlet version, optionally allowing it to a reverse
  86          * operation of the {@link #hashCode()} method.
  87          *
  88          * @param __hash If {@code true} then the value to decode is treated as
  89          * the hash code returned by this class.
  90          * @param __maj If {@code __hash} is {@code true} then this is the hash
  91          * code of a SuiteVersion, otherwise it is the major version number.
  92          * @throws InvalidSuiteException If the version number has an out of
  93          * range value.
  94          * @since 2016/10/13
  95          */
  96         @Exported
  97         public SuiteVersion(boolean __hash, int __maj)
  98                 throws InvalidSuiteException
  99         {
 100                 this((__hash ? __maj / 10000 : __maj),
 101                         (__hash ? (__maj / 100) % 100 : 0),
 102                         (__hash ? __maj % 100 : 0));
 103         }
 104
 105         /**
 106          * Initializes the version.
 107          *
 108          * @param __maj The major version.
 109          * @throws IllegalArgumentException If any value is out of range.
 110          * @since 2016/10/12
 111          */
 112         @Exported
 113         public SuiteVersion(int __maj)
 114         {
 115                 this(__maj, 0, 0);
 116         }
 117
 118         /**
 119          * Initializes the version.
 120          *
 121          * @param __maj The major version.
 122          * @param __min The minor version.
 123          * @throws IllegalArgumentException If any value is out of range.
 124          * @since 2016/10/12
 125          */
 126         @Exported
 127         public SuiteVersion(int __maj, int __min)
 128         {
 129                 this(__maj, __min, 0);
 130         }
 131
 132         /**
 133          * Initializes the version.
 134          *
 135          * @param __maj The major version.
 136          * @param __min The minor version.
 137          * @param __rel The release version.
 138          * @throws InvalidSuiteException If any value is out of range.
 139          * @since 2016/10/12
 140          */
 141         @Exported
 142         public SuiteVersion(int __maj, int __min, int __rel)
 143                 throws InvalidSuiteException
 144         {
 145                 // {@squirreljme.error DG0i Input version number is out of range, only
 146                 // 0 through 99 are valid. (The major version; The minor version; The
 147                 // release version)}
 148                 if (__maj < 0 || __maj > 99 || __min < 0 || __min > 99 ||
 149                         __rel < 0 || __rel > 99)
 150                         throw new InvalidSuiteException(String.format("AR0i %d %d %d",
 151                                 __maj, __min, __rel));
 152
 153                 // Set
 154                 this.major = __maj;
 155                 this.minor = __min;
 156                 this.release = __rel;
 157         }
 158
 159         /**
 160          * Checks if this version at least the specified verison.
 161          *
 162          * @param __v The version to check against.
 163          * @return {@code true} if this version is at least the other.
 164          * @throws NullPointerException On nul arguments.
 165          */
 166         @Exported
 167         public boolean atLeast(SuiteVersion __v)
 168                 throws NullPointerException
 169         {
 170                 // Check
 171                 if (__v == null)
 172                         throw new NullPointerException("NARG");
 173
 174                 // Can compare the hashcodes
 175                 return this.hashCode() >= __v.hashCode();
 176         }
 177
 178         /**
 179          * {@inheritDoc}
 180          * @since 2016/10/12
 181          */
 182         @Override
 183         public int compareTo(SuiteVersion __o)
 184         {
 185                 // Major first
 186                 int amaj = this.major, bmaj = __o.major;
 187                 int rv = amaj - bmaj;
 188                 if (rv != 0)
 189                         return rv;
 190
 191                 // Then minor
 192                 int amin = this.minor, bmin = __o.minor;
 193                 rv = amin - bmin;
 194                 if (rv != 0)
 195                         return rv;
 196
 197                 // Then release
 198                 int arel = this.release, brel = __o.release;
 199                 rv = arel - brel;
 200                 if (rv != 0)
 201                         return rv;
 202
 203                 // The same
 204                 return 0;
 205         }
 206
 207         /**
 208          * {@inheritDoc}
 209          * @since 2016/10/12
 210          */
 211         @Override
 212         public boolean equals(Object __o)
 213         {
 214                 // Check
 215                 if (!(__o instanceof SuiteVersion))
 216                         return false;
 217
 218                 // Cast
 219                 SuiteVersion o = (SuiteVersion)__o;
 220                 return this.major == o.major &&
 221                         this.minor == o.minor &&
 222                         this.release == o.release;
 223         }
 224
 225         /**
 226          * {@inheritDoc}
 227          * @since 2016/10/12
 228          */
 229         @Override
 230         public int hashCode()
 231         {
 232                 return (this.major * 10000) +
 233                         (this.minor * 100) +
 234                         this.release;
 235         }
 236
 237         /**
 238          * Returns the major version.
 239          *
 240          * @return The major version.
 241          * @since 2017/02/22
 242          */
 243         @Exported
 244         public int major()
 245         {
 246                 return this.major;
 247         }
 248
 249         /**
 250          * Returns the minor version.
 251          *
 252          * @return The minor version.
 253          * @since 2017/02/22
 254          */
 255         @Exported
 256         public int minor()
 257         {
 258                 return this.minor;
 259         }
 260
 261         /**
 262          * Returns the release version.
 263          *
 264          * @return The release version.
 265          * @since 2017/02/22
 266          */
 267         @Exported
 268         public int release()
 269         {
 270                 return this.release;
 271         }
 272
 273         /**
 274          * {@inheritDoc}
 275          * @since 2016/10/12
 276          */
 277         @Override
 278         public String toString()
 279         {
 280                 // Get
 281                 Reference<String> ref = this._string;
 282                 String rv;
 283
 284                 // Cache?
 285                 if (ref == null || null == (rv = ref.get()))
 286                         this._string = new WeakReference<>((rv = this.major + "." +
 287                                 this.minor + "." + this.release));
 288
 289                 // Return it
 290                 return rv;
 291         }
 292
 293         /**
 294          * Decodes the string based version number
 295          *
 296          * @param __v The input string.
 297          * @return The version tuplet.
 298          * @throws InvalidSuiteException If the input is not valid.
 299          * @throws NullPointerException On null arguments.
 300          * @since 2016/10/12
 301          */
 302         private static int[] __decodeVersion(String __v)
 303                 throws InvalidSuiteException, NullPointerException
 304         {
 305                 // Check
 306                 if (__v == null)
 307                         throw new NullPointerException("NARG");
 308
 309                 // Trim whitespace
 310                 __v = __v.trim();
 311
 312                 // Output array
 313                 int[] rv = new int[3];
 314
 315                 // Parse the input value
 316                 int n = __v.length(), at = 0;
 317                 StringBuilder sb = new StringBuilder();
 318                 for (int i = 0; i <= n; i++)
 319                 {
 320                         int c = (i == n ? -1 : __v.charAt(i));
 321
 322                         // Decimal point? or end
 323                         if (c == '.' || c == -1)
 324                         {
 325                                 rv[at++] = Integer.parseInt(sb.toString(), 10);
 326
 327                                 // {@squirreljme.error DG0j Too many version fields in the
 328                                 // specified string. (The input string)}
 329                                 if (c != -1 && at >= 4)
 330                                         throw new InvalidSuiteException(String.format("AR0j %s",
 331                                                 __v));
 332
 333                                 // Clear
 334                                 sb.setLength(0);
 335                         }
 336
 337                         // Add to string
 338                         else if (c >= '0' && c <= '9')
 339                                 sb.append((char)c);
 340
 341                         // {@squirreljme.error DG0k An illegal character is in the
 342                         // version string. (The input string; The illegal character)}
 343                         else
 344                                 throw new InvalidSuiteException(String.format("AR0k %s %04x",
 345                                         __v, c));
 346                 }
 347
 348                 // Return it
 349                 return rv;
 350         }
 351 }
 352