com.idevicesinc.sweetblue

Enum HistoricalDataLoadListener.Status

java.lang.Object

java.lang.Enum<HistoricalDataLoadListener.Status>

com.idevicesinc.sweetblue.HistoricalDataLoadListener.Status

All Implemented Interfaces:

UsesCustomNull, java.io.Serializable, java.lang.Comparable<HistoricalDataLoadListener.Status>

Enclosing interface:

HistoricalDataLoadListener

public static enum HistoricalDataLoadListener.Status
extends java.lang.Enum<HistoricalDataLoadListener.Status>
implements UsesCustomNull

Enumerates the status codes for operations kicked off from BleDevice.loadHistoricalData() (or overloads).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_LOADED BleDevice.loadHistoricalData() (or overloads) was called but the data was already loaded to memory.
ALREADY_LOADING Same idea as STARTED_LOADING, not an error status, but letting you know that the load was already in progress when BleDevice.loadHistoricalData() (or overloads) was called a second time.
LOADED Historical data is fully loaded to memory and ready to access synchronously (without blocking current thread) through BleDevice.getHistoricalData_iterator(UUID) (or overloads).
NOTHING_TO_LOAD BleDevice.loadHistoricalData() (or overloads) was called but there was no data available to load to memory.
NULL Fulfills soft contract of UsesCustomNull.
STARTED_LOADING BleDevice.loadHistoricalData() (or overloads) was called and the operation was successfully started - expect another HistoricalDataLoadListener.HistoricalDataLoadEvent with HistoricalDataLoadListener.HistoricalDataLoadEvent.status() being LOADED shortly.

Method Summary

Modifier and Type	Method and Description
boolean	isNull() Returns true if this== NULL.
static HistoricalDataLoadListener.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HistoricalDataLoadListener.Status[]	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

NULL

public static final HistoricalDataLoadListener.Status NULL

Fulfills soft contract of UsesCustomNull.

LOADED

public static final HistoricalDataLoadListener.Status LOADED

Historical data is fully loaded to memory and ready to access synchronously (without blocking current thread) through BleDevice.getHistoricalData_iterator(UUID) (or overloads).

ALREADY_LOADED

public static final HistoricalDataLoadListener.Status ALREADY_LOADED

BleDevice.loadHistoricalData() (or overloads) was called but the data was already loaded to memory.

NOTHING_TO_LOAD

public static final HistoricalDataLoadListener.Status NOTHING_TO_LOAD

BleDevice.loadHistoricalData() (or overloads) was called but there was no data available to load to memory.

STARTED_LOADING

public static final HistoricalDataLoadListener.Status STARTED_LOADING

BleDevice.loadHistoricalData() (or overloads) was called and the operation was successfully started - expect another HistoricalDataLoadListener.HistoricalDataLoadEvent with HistoricalDataLoadListener.HistoricalDataLoadEvent.status() being LOADED shortly.

ALREADY_LOADING

public static final HistoricalDataLoadListener.Status ALREADY_LOADING

Same idea as STARTED_LOADING, not an error status, but letting you know that the load was already in progress when BleDevice.loadHistoricalData() (or overloads) was called a second time. This doesn't affect the actual loading process at all, and LOADED will eventually be returned for both callbacks.

Method Detail

values

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

Returns:

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

valueOf

public static HistoricalDataLoadListener.Status 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

isNull

public boolean isNull()

Returns true if this== NULL.

Specified by:

isNull in interface UsesCustomNull