org.andengine.engine.options

Enum WakeLockOptions

java.lang.Object

java.lang.Enum<WakeLockOptions>

org.andengine.engine.options.WakeLockOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WakeLockOptions>

public enum WakeLockOptions
extends java.lang.Enum<WakeLockOptions>

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

19:45:23 - 10.07.2010

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRIGHT Screen is on at full brightness.
SCREEN_BRIGHT Screen is on at full brightness.
SCREEN_DIM Screen is on but may be dimmed.
SCREEN_ON Screen is on at full brightness.

Method Summary

Modifier and Type	Method and Description
int	getFlag()
static WakeLockOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WakeLockOptions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BRIGHT

public static final WakeLockOptions BRIGHT

Screen is on at full brightness. Keyboard backlight is on at full brightness. Requires WAKE_LOCK permission!

SCREEN_BRIGHT

public static final WakeLockOptions SCREEN_BRIGHT

Screen is on at full brightness. Keyboard backlight will be allowed to go off. Requires WAKE_LOCK permission!

SCREEN_DIM

public static final WakeLockOptions SCREEN_DIM

Screen is on but may be dimmed. Keyboard backlight will be allowed to go off. Requires WAKE_LOCK permission!

SCREEN_ON

public static final WakeLockOptions SCREEN_ON

Screen is on at full brightness. Does not require WAKE_LOCK permission!

Method Detail

values

public static WakeLockOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WakeLockOptions c : WakeLockOptions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WakeLockOptions valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getFlag

public int getFlag()