com.eyro.cubeacon

Enum Proximity

java.lang.Object

java.lang.Enum<Proximity>

com.eyro.cubeacon.Proximity

All Implemented Interfaces:

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

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

The enum of proximity beacon.

Version:

2.0.0

Author:

Eyro Labs

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAR Far proximity.
IMMEDIATE Immediate proximity.
NEAR Near proximity.
UNKNOWN Unknown proximity.

Method Summary

Modifier and Type	Method and Description
static Proximity	fromAccuracy(double accuracy) Get proximity from a beacon accuracy.
static Proximity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Proximity[]	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

UNKNOWN

public static final Proximity UNKNOWN

Unknown proximity.

IMMEDIATE

public static final Proximity IMMEDIATE

Immediate proximity.

NEAR

public static final Proximity NEAR

Near proximity.

FAR

public static final Proximity FAR

Far proximity.

Method Detail

values

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

Returns:

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

valueOf

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

fromAccuracy

public static Proximity fromAccuracy(double accuracy)

Get proximity from a beacon accuracy.

Parameters:

accuracy - The accuracy

Returns:

the proximity