modules/midp-lcdui/src/main/java/cc/squirreljme/runtime/lcdui/mle/Vibration.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.runtime.lcdui.mle;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.SquirrelJMEVendorApi;
  13 import cc.squirreljme.runtime.cldc.debug.Debugging;
  14
  15 /**
  16  * Support for vibration.
  17  *
  18  * @since 2022/02/14
  19  */
  20 @SquirrelJMEVendorApi
  21 public final class Vibration
  22 {
  23         /**
  24          * Not used.
  25          *
  26          * @since 2022/02/14
  27          */
  28         private Vibration()
  29         {
  30         }
  31
  32         /**
  33          * Attempts to vibrate the device for the given number of milliseconds.
  34          *
  35          * The values here only set the duration to vibrate for from the current
  36          * point in time and will not increase the length of vibration.
  37          *
  38          * The return value will be {@code false} if the display is in the
  39          * background, the device cannot vibrate, or the vibrator cannot be
  40          * controlled.
  41          *
  42          * Note that excessive vibration may cause the battery life for a device to
  43          * be lowered, thus it should be used sparingly.
  44          *
  45          * @param __d The number of milliseconds to vibrate for, if zero the
  46          * vibrator will be switched off.
  47          * @return {@code true} if the vibrator is controllable by this application
  48          * and the display is active.
  49          * @throws IllegalArgumentException If the duration is negative.
  50          * @since 2022/02/14
  51          */
  52         @SquirrelJMEVendorApi
  53         public static boolean vibrate(int __d)
  54                 throws IllegalArgumentException
  55         {
  56                 /* {@squirreljme.error EB1n Cannot vibrate for a negative duration.} */
  57                 if (__d < 0)
  58                         throw new IllegalArgumentException("EB1n");
  59
  60                 Debugging.todoNote("Vibration?");
  61                 return false;
  62         }
  63 }