buildSrc/src/main/java/cc/squirreljme/plugin/multivm/ClutterLevel.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // Multi-Phasic Applications: 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.multivm;
  11
  12 /**
  13  * Represents the clutter level that is used.
  14  *
  15  * @since 2023/01/28
  16  */
  17 public enum ClutterLevel
  18 {
  19         /** Release build. */
  20         RELEASE,
  21
  22         /** Debug build. */
  23         DEBUG,
  24
  25         /* End. */
  26         ;
  27
  28         /**
  29          * Is this considered a debug task?
  30          *
  31          * @return If this is considered debugging.
  32          * @since 2023/02/01
  33          */
  34         public final boolean isDebug()
  35         {
  36                 return this == ClutterLevel.DEBUG;
  37         }
  38
  39         /**
  40          * Returns the opposite clutter level.
  41          *
  42          * @return The opposite clutter level.
  43          * @since 2023/02/05
  44          */
  45         public final ClutterLevel opposite()
  46         {
  47                 if (this == ClutterLevel.RELEASE)
  48                         return ClutterLevel.DEBUG;
  49                 return ClutterLevel.RELEASE;
  50         }
  51
  52         /**
  53          * Returns the proper noun of the clutter level.
  54          *
  55          * @return The proper noun of the clutter level.
  56          * @since 2024/03/04
  57          */
  58         public String properNoun()
  59         {
  60                 if (this == ClutterLevel.RELEASE)
  61                         return "Release";
  62                 return "Debug";
  63         }
  64
  65         /**
  66          * {@inheritDoc}
  67          * @since 2023/01/28
  68          */
  69         @Override
  70         public String toString()
  71         {
  72                 if (this == ClutterLevel.RELEASE)
  73                         return "release";
  74                 return "debug";
  75         }
  76 }