modules/cldc-compact/src/main/java/cc/squirreljme/jvm/suite/MatchResult.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 cc.squirreljme.runtime.cldc.debug.Debugging;
  14
  15 /**
  16  * This class contains the results of a dependency match.
  17  *
  18  * @since 2017/11/30
  19  */
  20 @Exported
  21 public final class MatchResult
  22 {
  23         /** The matched results. */
  24         protected final DependencyInfo matched;
  25
  26         /** The unmatched results. */
  27         protected final DependencyInfo unmatched;
  28
  29         /**
  30          * Initializes the match result.
  31          *
  32          * @param __matched The matched dependencies.
  33          * @param __unmatched The unmatched dependencies.
  34          * @throws NullPointerException On null arguments.
  35          * @since 2017/12/31
  36          */
  37         @Exported
  38         public MatchResult(DependencyInfo __matched, DependencyInfo __unmatched)
  39                 throws NullPointerException
  40         {
  41                 if (__matched == null || __unmatched == null)
  42                         throw new NullPointerException("NARG");
  43
  44                 this.matched = __matched;
  45                 this.unmatched = __unmatched;
  46         }
  47
  48         /**
  49          * {@inheritDoc}
  50          * @since 2017/12/31
  51          */
  52         @Override
  53         public boolean equals(Object __o)
  54         {
  55                 if (this == __o)
  56                         return true;
  57
  58                 if (!(__o instanceof MatchResult))
  59                         return false;
  60
  61                 MatchResult o = (MatchResult)__o;
  62                 return this.matched.equals(o.matched) &&
  63                         this.unmatched.equals(o.unmatched);
  64         }
  65
  66         /**
  67          * Returns {@code true} if there have been matches in the result.
  68          *
  69          * @return Has there been any matches?
  70          * @since 2017/11/30
  71          */
  72         @Exported
  73         public final boolean hasMatches()
  74         {
  75                 return !this.matched.isEmpty();
  76         }
  77
  78         /**
  79          * {@inheritDoc}
  80          * @since 2017/12/31
  81          */
  82         @Override
  83         public final int hashCode()
  84         {
  85                 return this.matched.hashCode() ^
  86                         this.unmatched.hashCode();
  87         }
  88
  89         /**
  90          * Returns the dependency information which contains every dependency
  91          * which has been matched.
  92          *
  93          * @return The dependency information containing only matched items.
  94          * @since 2017/11/30
  95          */
  96         @Exported
  97         public final DependencyInfo matched()
  98         {
  99                 return this.matched;
 100         }
 101
 102         /**
 103          * Returns the dependency information which contains every dependency
 104          * which has yet to be matched.
 105          *
 106          * @return The dependency information containing only unmatched items.
 107          * @since 2017/11/30
 108          */
 109         @Exported
 110         public final DependencyInfo unmatched()
 111         {
 112                 return this.unmatched;
 113         }
 114
 115         /**
 116          * {@inheritDoc}
 117          * @since 2017/12/31
 118          */
 119         @Override
 120         public final String toString()
 121         {
 122                 throw Debugging.todo();
 123         }
 124 }
 125