Module com.gluonhq.attach.ble

Package com.gluonhq.attach.ble

Enum Class Proximity

java.lang.Object

java.lang.Enum<Proximity>

com.gluonhq.attach.ble.Proximity

All Implemented Interfaces:

Serializable, Comparable<Proximity>, Constable

public enum Proximity
extends Enum<Proximity>

Proximity is based on the estimated distance between beacon and device. It gives a general sense of distance.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAR
IMMEDIATE
NEAR
UNKNOWN

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAR

public static final Proximity FAR

NEAR

public static final Proximity NEAR

IMMEDIATE

public static final Proximity IMMEDIATE

UNKNOWN

public static final Proximity UNKNOWN

Method Details

values

public static Proximity[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Proximity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getProximity

public int getProximity()