modules/tool-classfile/src/main/java/net/multiphasicapps/classfile/Identifier.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 net.multiphasicapps.classfile;
  11
  12 /**
  13  * This represents an identifier which acts as a name of a fragment of a class
  14  * or a member of a class.
  15  *
  16  * @since 2017/06/12
  17  */
  18 public abstract class Identifier
  19 {
  20         /** The string which makes up the identifier. */
  21         protected final String string;
  22
  23         /**
  24          * Initializes the identifier.
  25          *
  26          * @param __n The input identifier to decode.
  27          * @throws InvalidClassFormatException If it is not a valid identifier.
  28          * @throws NullPointerException On null arguments.
  29          * @since 2017/06/12
  30          */
  31         Identifier(String __n)
  32                 throws InvalidClassFormatException, NullPointerException
  33         {
  34                 // Check
  35                 if (__n == null)
  36                         throw new NullPointerException("NARG");
  37
  38                 // Set
  39                 this.string = __n;
  40
  41                 // Check characters
  42                 for (int i = 0, n = __n.length(); i < n; i++)
  43                 {
  44                         char c = __n.charAt(i);
  45
  46                         // {@squirreljme.error JC2x The specified identifier contains an
  47                         // invalid character. (The identifier)}
  48                         if (c == '.' || c == ';' || c == '[' || c == '/')
  49                                 throw new InvalidClassFormatException(
  50                                         String.format("JC2x %s", __n));
  51                 }
  52         }
  53
  54         /**
  55          * {@inheritDoc}
  56          * @since 2017/06/12
  57          */
  58         @Override
  59         public boolean equals(Object __o)
  60         {
  61                 if (this == __o)
  62                         return true;
  63
  64                 // Check
  65                 if (!(__o instanceof Identifier))
  66                         return false;
  67
  68                 return this.string.equals(((Identifier)__o).string);
  69         }
  70
  71         /**
  72          * {@inheritDoc}
  73          * @since 2017/06/12
  74          */
  75         @Override
  76         public int hashCode()
  77         {
  78                 return this.string.hashCode();
  79         }
  80
  81         /**
  82          * Returns the identifier.
  83          *
  84          * @return The identifier.
  85          * @since 2017/10/02
  86          */
  87         public final String identifier()
  88         {
  89                 return this.string;
  90         }
  91
  92         /**
  93          * {@inheritDoc}
  94          * @since 2017/06/12
  95          */
  96         @Override
  97         public String toString()
  98         {
  99                 return this.string;
 100         }
 101 }
 102