com.idevicesinc.sweetblue

Class BleCharacteristic

java.lang.Object

com.idevicesinc.sweetblue.internal.P_NativeGattObject<android.bluetooth.BluetoothGattCharacteristic>

com.idevicesinc.sweetblue.BleCharacteristic

All Implemented Interfaces:

UsesCustomNull, UsesInstanceId

public final class BleCharacteristic
extends P_NativeGattObject<android.bluetooth.BluetoothGattCharacteristic>
implements UsesInstanceId

Wrapper class which holds an instance of BluetoothGattCharacteristic. You should always check P_NativeGattObject.isNull() before doing anything with the BluetoothGattCharacteristic returned from getCharacteristic().

Field Summary

Fields

Modifier and Type	Field and Description
static BleCharacteristic	NULL
static int	PROPERTY_INDICATE
static int	PROPERTY_NOTIFY
static int	PROPERTY_READ
static int	PROPERTY_SIGNED_WRITE
static int	PROPERTY_WRITE
static int	PROPERTY_WRITE_NO_RESPONSE
static int	WRITE_TYPE_NO_RESPONSE
static int	WRITE_TYPE_SIGNED

Constructor Summary

Constructors

Constructor and Description
BleCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)
BleCharacteristic(UhOhListener.UhOh uhoh)

Method Summary

Modifier and Type	Method and Description
android.bluetooth.BluetoothGattCharacteristic	getCharacteristic() Returns the instance of BluetoothGattCharacteristic held in this class.
BleDescriptor	getDescriptor(java.util.UUID descriptorUuid) Returns an instance of BleDescriptor that holds the native BluetoothGattDescriptor for the UUID requested.
java.util.List<BleDescriptor>	getDescriptors() Returns a list of BleDescriptors held in this characteristic.
int	getInstanceId()
BleService	getService() Returns an instance of BleService that holds the native BluetoothGattService which this characteristic belongs to.
java.util.UUID	getUuid() Forwards BluetoothGattCharacteristic.getUuid().
byte[]	getValue() Forwards BluetoothGattCharacteristic.getValue().
void	setInstanceId(int id)

Methods inherited from class com.idevicesinc.sweetblue.internal.P_NativeGattObject

equals, getGattObject, getUhOh, hasUhOh, isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_NOTIFY

public static final int PROPERTY_NOTIFY

See Also:

Constant Field Values

PROPERTY_INDICATE

public static final int PROPERTY_INDICATE

See Also:

Constant Field Values

PROPERTY_WRITE

public static final int PROPERTY_WRITE

See Also:

Constant Field Values

PROPERTY_WRITE_NO_RESPONSE

public static final int PROPERTY_WRITE_NO_RESPONSE

See Also:

Constant Field Values

PROPERTY_SIGNED_WRITE

public static final int PROPERTY_SIGNED_WRITE

See Also:

Constant Field Values

PROPERTY_READ

public static final int PROPERTY_READ

See Also:

Constant Field Values

WRITE_TYPE_NO_RESPONSE

public static final int WRITE_TYPE_NO_RESPONSE

See Also:

Constant Field Values

WRITE_TYPE_SIGNED

public static final int WRITE_TYPE_SIGNED

See Also:

Constant Field Values

NULL

public static final BleCharacteristic NULL

Constructor Detail

BleCharacteristic

public BleCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)

BleCharacteristic

public BleCharacteristic(UhOhListener.UhOh uhoh)

Method Detail

getCharacteristic

public final android.bluetooth.BluetoothGattCharacteristic getCharacteristic()

Returns the instance of BluetoothGattCharacteristic held in this class.

getDescriptors

public final java.util.List<BleDescriptor> getDescriptors()

Returns a list of BleDescriptors held in this characteristic.

getUuid

public final java.util.UUID getUuid()

Forwards BluetoothGattCharacteristic.getUuid(). Will return Uuids.INVALID if the backing characteristic is null.

getValue

public final byte[] getValue()

Forwards BluetoothGattCharacteristic.getValue(). Will return an empty array if the backing characteristic is null.

getService

public final BleService getService()

Returns an instance of BleService that holds the native BluetoothGattService which this characteristic belongs to. If the backing characteristic is null, BleService.NULL will be returned.

getDescriptor

public final BleDescriptor getDescriptor(java.util.UUID descriptorUuid)

Returns an instance of BleDescriptor that holds the native BluetoothGattDescriptor for the UUID requested. If the descriptor is not found, BleDescriptor.NULL will be returned.

setInstanceId

public void setInstanceId(int id)

Specified by:

setInstanceId in interface UsesInstanceId

getInstanceId

public int getInstanceId()

Specified by:

getInstanceId in interface UsesInstanceId