com.idevicesinc.sweetblue

Enum NotificationListener.Type

java.lang.Object

java.lang.Enum<NotificationListener.Type>

com.idevicesinc.sweetblue.NotificationListener.Type

All Implemented Interfaces:

UsesCustomNull, java.io.Serializable, java.lang.Comparable<NotificationListener.Type>

Enclosing interface:

NotificationListener

public static enum NotificationListener.Type
extends java.lang.Enum<NotificationListener.Type>
implements UsesCustomNull

The type of operation for a ReadWriteListener.ReadWriteEvent - read, write, poll, etc.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLING_NOTIFICATION Opposite of ENABLING_NOTIFICATION.
ENABLING_NOTIFICATION Associated with BleDevice.enableNotify(UUID, ReadWriteListener) and called when enabling the notification completes by writing to the Descriptor of the given UUID.
INDICATION Similar to NOTIFICATION, kicked off from BleDevice.enableNotify(UUID, ReadWriteListener), but under the hood this is treated slightly differently.
NOTIFICATION Associated with BleDevice.enableNotify(UUID, ReadWriteListener) when we actually get a notification.
NULL As of now, only used for DeviceReconnectFilter.ConnectFailEvent.txnFailReason() in some cases.
PSEUDO_NOTIFICATION Associated with BleDevice.startChangeTrackingPoll(UUID, Interval, ReadWriteListener) or BleDevice.enableNotify(UUID, Interval, ReadWriteListener) where a force-read timeout is invoked.

Method Summary

Modifier and Type	Method and Description
boolean	isNativeNotification() Returns true only for NOTIFICATION and INDICATION, i.e.
boolean	isNull() Returns true if the object's state represents what would otherwise be Java's built-in null.
BleNodeConfig.HistoricalDataLogFilter.Source	toHistoricalDataSource() Returns the BleNodeConfig.HistoricalDataLogFilter.Source equivalent for this NotificationListener.Type, or BleNodeConfig.HistoricalDataLogFilter.Source.NULL.
static NotificationListener.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NotificationListener.Type[]	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 NotificationListener.Type NULL

As of now, only used for DeviceReconnectFilter.ConnectFailEvent.txnFailReason() in some cases.

NOTIFICATION

public static final NotificationListener.Type NOTIFICATION

Associated with BleDevice.enableNotify(UUID, ReadWriteListener) when we actually get a notification.

INDICATION

public static final NotificationListener.Type INDICATION

Similar to NOTIFICATION, kicked off from BleDevice.enableNotify(UUID, ReadWriteListener), but under the hood this is treated slightly differently.

PSEUDO_NOTIFICATION

public static final NotificationListener.Type PSEUDO_NOTIFICATION

Associated with BleDevice.startChangeTrackingPoll(UUID, Interval, ReadWriteListener) or BleDevice.enableNotify(UUID, Interval, ReadWriteListener) where a force-read timeout is invoked.

ENABLING_NOTIFICATION

public static final NotificationListener.Type ENABLING_NOTIFICATION

Associated with BleDevice.enableNotify(UUID, ReadWriteListener) and called when enabling the notification completes by writing to the Descriptor of the given UUID. ReadWriteListener.Status.SUCCESS doesn't necessarily mean that notifications will definitely now work (there may be other issues in the underlying stack), but it's a reasonable guarantee.

DISABLING_NOTIFICATION

public static final NotificationListener.Type DISABLING_NOTIFICATION

Opposite of ENABLING_NOTIFICATION.

Method Detail

values

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

Returns:

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

valueOf

public static NotificationListener.Type 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

isNativeNotification

public boolean isNativeNotification()

Returns true only for NOTIFICATION and INDICATION, i.e. only notifications whose origin is an *actual* notification (or indication) sent from the remote BLE device (as opposed to a PSEUDO_NOTIFICATION).

toHistoricalDataSource

public BleNodeConfig.HistoricalDataLogFilter.Source toHistoricalDataSource()

Returns the BleNodeConfig.HistoricalDataLogFilter.Source equivalent for this NotificationListener.Type, or BleNodeConfig.HistoricalDataLogFilter.Source.NULL.

isNull

public boolean isNull()

Description copied from interface: UsesCustomNull

Returns true if the object's state represents what would otherwise be Java's built-in null.

Specified by:

isNull in interface UsesCustomNull