Java tutorial
/* * Copyright (C) 2006 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.os; import android.annotation.IntDef; import android.annotation.RequiresPermission; import android.annotation.SystemService; import android.annotation.UnsupportedAppUsage; import android.app.ActivityThread; import android.content.Context; import android.media.AudioAttributes; import android.util.Log; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** * Class that operates the vibrator on the device. * <p> * If your process exits, any vibration you started will stop. * </p> */ @SystemService(Context.VIBRATOR_SERVICE) public abstract class Vibrator { private static final String TAG = "Vibrator"; /** * Vibration intensity: no vibrations. * @hide */ public static final int VIBRATION_INTENSITY_OFF = 0; /** * Vibration intensity: low. * @hide */ public static final int VIBRATION_INTENSITY_LOW = 1; /** * Vibration intensity: medium. * @hide */ public static final int VIBRATION_INTENSITY_MEDIUM = 2; /** * Vibration intensity: high. * @hide */ public static final int VIBRATION_INTENSITY_HIGH = 3; /** @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = { "VIBRATION_INTENSITY_" }, value = { VIBRATION_INTENSITY_OFF, VIBRATION_INTENSITY_LOW, VIBRATION_INTENSITY_MEDIUM, VIBRATION_INTENSITY_HIGH }) public @interface VibrationIntensity { } private final String mPackageName; // The default vibration intensity level for haptic feedback. @VibrationIntensity private final int mDefaultHapticFeedbackIntensity; // The default vibration intensity level for notifications. @VibrationIntensity private final int mDefaultNotificationVibrationIntensity; /** * @hide to prevent subclassing from outside of the framework */ @UnsupportedAppUsage public Vibrator() { mPackageName = ActivityThread.currentPackageName(); final Context ctx = ActivityThread.currentActivityThread().getSystemContext(); mDefaultHapticFeedbackIntensity = loadDefaultIntensity(ctx, com.android.internal.R.integer.config_defaultHapticFeedbackIntensity); mDefaultNotificationVibrationIntensity = loadDefaultIntensity(ctx, com.android.internal.R.integer.config_defaultNotificationVibrationIntensity); } /** * @hide to prevent subclassing from outside of the framework */ protected Vibrator(Context context) { mPackageName = context.getOpPackageName(); mDefaultHapticFeedbackIntensity = loadDefaultIntensity(context, com.android.internal.R.integer.config_defaultHapticFeedbackIntensity); mDefaultNotificationVibrationIntensity = loadDefaultIntensity(context, com.android.internal.R.integer.config_defaultNotificationVibrationIntensity); } private int loadDefaultIntensity(Context ctx, int resId) { return ctx != null ? ctx.getResources().getInteger(resId) : VIBRATION_INTENSITY_MEDIUM; } /** * Get the default vibration intensity for haptic feedback. * @hide */ public int getDefaultHapticFeedbackIntensity() { return mDefaultHapticFeedbackIntensity; } /** * Get the default vibration intensity for notifications and ringtones. * @hide */ public int getDefaultNotificationVibrationIntensity() { return mDefaultNotificationVibrationIntensity; } /** * Check whether the hardware has a vibrator. * * @return True if the hardware has a vibrator, else false. */ public abstract boolean hasVibrator(); /** * Check whether the vibrator has amplitude control. * * @return True if the hardware can control the amplitude of the vibrations, otherwise false. */ public abstract boolean hasAmplitudeControl(); /** * Vibrate constantly for the specified period of time. * * @param milliseconds The number of milliseconds to vibrate. * * @deprecated Use {@link #vibrate(VibrationEffect)} instead. */ @Deprecated @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(long milliseconds) { vibrate(milliseconds, null); } /** * Vibrate constantly for the specified period of time. * * @param milliseconds The number of milliseconds to vibrate. * @param attributes {@link AudioAttributes} corresponding to the vibration. For example, * specify {@link AudioAttributes#USAGE_ALARM} for alarm vibrations or * {@link AudioAttributes#USAGE_NOTIFICATION_RINGTONE} for * vibrations associated with incoming calls. * * @deprecated Use {@link #vibrate(VibrationEffect, AudioAttributes)} instead. */ @Deprecated @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(long milliseconds, AudioAttributes attributes) { try { // This ignores all exceptions to stay compatible with pre-O implementations. VibrationEffect effect = VibrationEffect.createOneShot(milliseconds, VibrationEffect.DEFAULT_AMPLITUDE); vibrate(effect, attributes); } catch (IllegalArgumentException iae) { Log.e(TAG, "Failed to create VibrationEffect", iae); } } /** * Vibrate with a given pattern. * * <p> * Pass in an array of ints that are the durations for which to turn on or off * the vibrator in milliseconds. The first value indicates the number of milliseconds * to wait before turning the vibrator on. The next value indicates the number of milliseconds * for which to keep the vibrator on before turning it off. Subsequent values alternate * between durations in milliseconds to turn the vibrator off or to turn the vibrator on. * </p><p> * To cause the pattern to repeat, pass the index into the pattern array at which * to start the repeat, or -1 to disable repeating. * </p> * * @param pattern an array of longs of times for which to turn the vibrator on or off. * @param repeat the index into pattern at which to repeat, or -1 if * you don't want to repeat. * * @deprecated Use {@link #vibrate(VibrationEffect)} instead. */ @Deprecated @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(long[] pattern, int repeat) { vibrate(pattern, repeat, null); } /** * Vibrate with a given pattern. * * <p> * Pass in an array of ints that are the durations for which to turn on or off * the vibrator in milliseconds. The first value indicates the number of milliseconds * to wait before turning the vibrator on. The next value indicates the number of milliseconds * for which to keep the vibrator on before turning it off. Subsequent values alternate * between durations in milliseconds to turn the vibrator off or to turn the vibrator on. * </p><p> * To cause the pattern to repeat, pass the index into the pattern array at which * to start the repeat, or -1 to disable repeating. * </p> * * @param pattern an array of longs of times for which to turn the vibrator on or off. * @param repeat the index into pattern at which to repeat, or -1 if * you don't want to repeat. * @param attributes {@link AudioAttributes} corresponding to the vibration. For example, * specify {@link AudioAttributes#USAGE_ALARM} for alarm vibrations or * {@link AudioAttributes#USAGE_NOTIFICATION_RINGTONE} for * vibrations associated with incoming calls. * * @deprecated Use {@link #vibrate(VibrationEffect, AudioAttributes)} instead. */ @Deprecated @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(long[] pattern, int repeat, AudioAttributes attributes) { // This call needs to continue throwing ArrayIndexOutOfBoundsException but ignore all other // exceptions for compatibility purposes if (repeat < -1 || repeat >= pattern.length) { Log.e(TAG, "vibrate called with repeat index out of bounds" + " (pattern.length=" + pattern.length + ", index=" + repeat + ")"); throw new ArrayIndexOutOfBoundsException(); } try { vibrate(VibrationEffect.createWaveform(pattern, repeat), attributes); } catch (IllegalArgumentException iae) { Log.e(TAG, "Failed to create VibrationEffect", iae); } } @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(VibrationEffect vibe) { vibrate(vibe, null); } @RequiresPermission(android.Manifest.permission.VIBRATE) public void vibrate(VibrationEffect vibe, AudioAttributes attributes) { vibrate(Process.myUid(), mPackageName, vibe, attributes); } /** * Like {@link #vibrate(VibrationEffect, AudioAttributes)}, but allowing the caller to specify * that the vibration is owned by someone else. * @hide */ @RequiresPermission(android.Manifest.permission.VIBRATE) public abstract void vibrate(int uid, String opPkg, VibrationEffect vibe, AudioAttributes attributes); /** * Turn the vibrator off. */ @RequiresPermission(android.Manifest.permission.VIBRATE) public abstract void cancel(); }