com.kontakt.sdk.android.common

Enum Proximity

java.lang.Object

java.lang.Enum<Proximity>

com.kontakt.sdk.android.common.Proximity

All Implemented Interfaces:

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

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

Proximity describes relative distance to the beacon. Being consistent with iOS naming convention and philosophy the proximities are split into three categorized values: IMMEDIATE, NEAR, FAR.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAR Android device distance from Beacon is higher than 3m.
IMMEDIATE Android device distance from Beacon is within [0 - 0,5]m.
NEAR Android device distance from Beacon is within [0,5 - 3]m.
UNKNOWN The UNKNOWN.

Method Summary

Modifier and Type	Method and Description
static Proximity	fromDistance(double accuracy) Categorizes accuracy to Proximity.
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

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

IMMEDIATE

public static final Proximity IMMEDIATE

Android device distance from Beacon is within [0 - 0,5]m.

NEAR

public static final Proximity NEAR

Android device distance from Beacon is within [0,5 - 3]m.

FAR

public static final Proximity FAR

Android device distance from Beacon is higher than 3m.

UNKNOWN

public static final Proximity UNKNOWN

The UNKNOWN.

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

fromDistance

public static Proximity fromDistance(double accuracy)

Categorizes accuracy to Proximity.

Parameters:

accuracy - the accuracy

Returns:

the proximity