buildSrc/src/main/java/cc/squirreljme/plugin/swm/SuiteName.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 Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.swm;
  11
  12 import cc.squirreljme.plugin.util.StringUtils;
  13
  14 /**
  15  * This represents the name of a midlet suite.
  16  *
  17  * @since 2016/10/12
  18  */
  19 public final class SuiteName
  20         implements Comparable<SuiteName>
  21 {
  22         /** String value. */
  23         protected final String string;
  24
  25         /**
  26          * Initializes the suite name.
  27          *
  28          * @param __v The value to parse.
  29          * @throws InvalidSuiteException If the input is not valid.
  30          * @throws NullPointerException On null arguments.
  31          * @since 2016/10/12
  32          */
  33         public SuiteName(String __v)
  34                 throws InvalidSuiteException, NullPointerException
  35         {
  36                 // Check
  37                 if (__v == null)
  38                         throw new NullPointerException("NARG");
  39
  40                 /* {@squirreljme.error DG0e An illegal character was
  41                 specified in the midlet suite name. (The midlet suite
  42                 name)} */
  43                 if (StringUtils.firstIndex("\0\r\n:;", __v) >= 0)
  44                         throw new InvalidSuiteException(String.format("AR0e %s", __v));
  45
  46                 this.string = __v;
  47         }
  48
  49         /**
  50          * {@inheritDoc}
  51          * @since 2016/10/12
  52          */
  53         @Override
  54         public int compareTo(SuiteName __o)
  55         {
  56                 if (this == __o)
  57                         return 0;
  58                 return this.string.compareTo(__o.string);
  59         }
  60
  61         /**
  62          * {@inheritDoc}
  63          * @since 2016/10/12
  64          */
  65         @Override
  66         public boolean equals(Object __o)
  67         {
  68                 if (this == __o)
  69                         return true;
  70
  71                 // Check
  72                 if (!(__o instanceof SuiteName))
  73                         return false;
  74
  75                 return this.string.equals(((SuiteName)__o).string);
  76         }
  77
  78         /**
  79          * {@inheritDoc}
  80          * @since 2016/10/12
  81          */
  82         @Override
  83         public int hashCode()
  84         {
  85                 return this.string.hashCode();
  86         }
  87
  88         /**
  89          * {@inheritDoc}
  90          * @since 2016/10/12
  91          */
  92         @Override
  93         public String toString()
  94         {
  95                 return this.string;
  96         }
  97 }
  98