modules/meep-swm/src/main/java/javax/microedition/swm/SuiteInstaller.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 javax.microedition.swm;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Api;
  13 import cc.squirreljme.runtime.cldc.debug.Debugging;
  14 import cc.squirreljme.runtime.swm.JarStreamSupplier;
  15 import java.util.Set;
  16 import net.multiphasicapps.collections.IdentityLinkedHashSet;
  17
  18 /**
  19  * This class is created when a suite is to be installed.
  20  *
  21  * @since 2016/06/24
  22  */
  23 @Api
  24 public final class SuiteInstaller
  25 {
  26         /** The supplier for the JAR data. */
  27         final JarStreamSupplier _supplier;
  28
  29         /** Listeners for suites. */
  30         final Set<SuiteInstallListener> _listeners =
  31                 new IdentityLinkedHashSet<>();
  32
  33         /**
  34          * Internal use only.
  35          *
  36          * @param __sup The supplier for JAR files.
  37          * @throws NullPointerException On null arguments.
  38          * @since 2016/06/24
  39          */
  40         SuiteInstaller(JarStreamSupplier __sup)
  41                 throws NullPointerException
  42         {
  43                 if (__sup == null)
  44                         throw new NullPointerException("NARG");
  45
  46                 this._supplier = __sup;
  47         }
  48
  49         /**
  50          * Adds a suite installation listener which can be given status updates
  51          * when a suite's installation status has changed.
  52          *
  53          * @param __sl The listener to add.
  54          * @since 2016/06/24
  55          */
  56         @Api
  57         public final void addInstallationListener(SuiteInstallListener __sl)
  58         {
  59                 // Ignore
  60                 if (__sl == null)
  61                         return;
  62
  63                 this._listeners.add(__sl);
  64         }
  65
  66         /**
  67          * Cancels the current installation.
  68          *
  69          * @since 2016/06/24
  70          */
  71         @Api
  72         public final void cancel()
  73         {
  74                 throw Debugging.todo();
  75         }
  76
  77         /**
  78          * Removes the given installation listener so that it no longer is notified
  79          * of installation updates.
  80          *
  81          * @param __sl The listener to remove.
  82          * @since 2016/06/24
  83          */
  84         @Api
  85         public final void removeInstallationListener(SuiteInstallListener __sl)
  86         {
  87                 // Ignore
  88                 if (__sl == null)
  89                         return;
  90
  91                 this._listeners.remove(__sl);
  92         }
  93
  94         /**
  95          * Starts installation of the given suite.
  96          *
  97          * If this is called twice then the next installation attempt is
  98          * enqueued regardless if the previous installation has succeeded or
  99          * failed.
 100          *
 101          * If there is not enough permission to install the given suite then
 102          * {@link InstallErrorCodes#UNAUTHORIZED_INSTALL} is set.
 103          *
 104          * @return The tracker for the given suite.
 105          * @since 2016/06/24
 106          */
 107         @Api
 108         public final SuiteManagementTracker start()
 109         {
 110                 return new __SuiteTracker__(this);
 111         }
 112 }
 113