com.eyro.cubeacon.constant

Enum ScanningMode

java.lang.Object

java.lang.Enum<ScanningMode>

com.eyro.cubeacon.constant.ScanningMode

All Implemented Interfaces:

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

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

The enum of beacon scanning period and wait time mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH High scanning mode.
LOW Low scanning mode.
NORMAL Normal scanning mode.
VERY_HIGH Very high scanning mode.

Method Summary

Modifier and Type	Method and Description
long	getBackgroundScanPeriod() Gets background scan period in milliseconds.
long	getBackgroundWaitTime() Gets background wait time in milliseconds.
long	getForegroundScanPeriod() Gets foreground scan period in milliseconds.
long	getForegroundWaitTime() Gets foreground wait time in milliseconds.
static ScanningMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScanningMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERY_HIGH

public static final ScanningMode VERY_HIGH

Very high scanning mode. Best scanning result but drain a lot of battery life, use it only on development process!

HIGH

public static final ScanningMode HIGH

High scanning mode. Better scanning result, but draining battery life!

NORMAL

public static final ScanningMode NORMAL

Normal scanning mode. Good balance between scanning result and battery life, recommended for production!

LOW

public static final ScanningMode LOW

Low scanning mode. Use it for a long battery life!

Method Detail

values

public static ScanningMode[] 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 (ScanningMode c : ScanningMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScanningMode 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

getForegroundScanPeriod

public long getForegroundScanPeriod()

Gets foreground scan period in milliseconds.

Returns:

the foreground scan period

getForegroundWaitTime

public long getForegroundWaitTime()

Gets foreground wait time in milliseconds.

Returns:

the foreground wait time

getBackgroundScanPeriod

public long getBackgroundScanPeriod()

Gets background scan period in milliseconds.

Returns:

the background scan period

getBackgroundWaitTime

public long getBackgroundWaitTime()

Gets background wait time in milliseconds.

Returns:

the background wait time