BleNode

java.lang.Object
- com.idevicesinc.sweetblue.BleNode

All Implemented Interfaces:

UsesCustomNull

Direct Known Subclasses:

BleDevice, BleServer
```
public abstract class BleNode
extends java.lang.Object
implements UsesCustomNull
```
Abstract base class for BleDevice and BleServer, mostly just to statically tie their APIs together wherever possible. That is, not much actual shared implementation exists in this class as of this writing.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.Object`	`appData` Field for app to associate any data it wants with instances of this class instead of having to subclass or manage associative hash maps or something.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`appData()` Convenience method that casts `appData` for you.
`<T extends BleNode> T`	`cast()` Just some sugar for casting to subclasses.
`<T extends BleNode> T`	`cast(java.lang.Class<T> type)` Safer version of `cast()` that will return `BleDevice.NULL` or `BleServer.NULL` if the cast cannot be made.
`abstract java.lang.String`	`getMacAddress()` Returns the MAC address of the remote `BleDevice` or local `BleServer`.
`BleManager`	`getManager()` Returns this endpoint's manager.
`BleCharacteristic`	`getNativeBleCharacteristic(java.util.UUID charUuid)` Returns the native characteristic for the given UUID in case you need lower-level access.
`BleCharacteristic`	`getNativeBleCharacteristic(java.util.UUID serviceUuid, java.util.UUID charUuid)` Overload of `getNativeBleCharacteristic(UUID)` for when you have characteristics with identical uuids under different services.
`BleDescriptor`	`getNativeBleDescriptor_inChar(java.util.UUID charUuid, java.util.UUID descUuid)` Overload of `getNativeBleDescriptor(UUID, UUID, UUID)` that will return the first descriptor we find inside the given characteristic matching the given `UUID`.
`BleDescriptor`	`getNativeBleDescriptor_inService(java.util.UUID serviceUuid, java.util.UUID descUuid)` Overload of `getNativeBleDescriptor(UUID, UUID, UUID)` that will return the first descriptor we find inside the given service matching the given `UUID`.
`BleDescriptor`	`getNativeBleDescriptor(java.util.UUID descUuid)` Overload of `getNativeBleDescriptor(UUID, UUID, UUID)` that will return the first descriptor we find matching the given `UUID`.
`BleDescriptor`	`getNativeBleDescriptor(java.util.UUID serviceUuid, java.util.UUID charUuid, java.util.UUID descUuid)` Returns the `BleDescriptor` for the given UUID in case you need lower-level access.
`BleService`	`getNativeBleService(java.util.UUID serviceUuid)` Returns the native service for the given UUID in case you need lower-level access.
`BleCharacteristic`	`getNativeCharacteristic(java.util.UUID serviceUuid, java.util.UUID charUuid, DescriptorFilter descriptorFilter)` Overload of `getNativeBleCharacteristic(UUID, UUID)` for when you have characteristics with identical uuids within the same service.
`java.util.List<BleCharacteristic>`	`getNativeCharacteristics_List()` Convenience overload of `getNativeCharacteristics()` that returns a `List`.
`java.util.List<BleCharacteristic>`	`getNativeCharacteristics_List(java.util.UUID serviceUuid)` Convenience overload of `getNativeCharacteristics(UUID)` that returns a `List`.
`java.util.Iterator<BleCharacteristic>`	`getNativeCharacteristics()` Returns all `BluetoothGattCharacteristic` instances.
`void`	`getNativeCharacteristics(ForEach_Breakable<BleCharacteristic> forEach)` Overload of `getNativeCharacteristics()` that uses a for each construct instead of returning an iterator.
`void`	`getNativeCharacteristics(ForEach_Void<BleCharacteristic> forEach)` Overload of `getNativeCharacteristics()` that uses a for each construct instead of returning an iterator.
`java.util.Iterator<BleCharacteristic>`	`getNativeCharacteristics(java.util.UUID serviceUuid)` Same as `getNativeCharacteristics()` but you can filter on the service `UUID`.
`void`	`getNativeCharacteristics(java.util.UUID serviceUuid, ForEach_Breakable<BleCharacteristic> forEach)` Overload of `getNativeCharacteristics(UUID)` that uses a for each construct instead of returning an iterator.
`void`	`getNativeCharacteristics(java.util.UUID serviceUuid, ForEach_Void<BleCharacteristic> forEach)` Overload of `getNativeCharacteristics(UUID)` that uses a for each construct instead of returning an iterator.
`java.util.List<BleDescriptor>`	`getNativeDescriptors_inChar_List(java.util.UUID charUuid)` Returns all descriptors on this node in the given characteristic as a list.
`java.util.Iterator<BleDescriptor>`	`getNativeDescriptors_inChar(java.util.UUID charUuid)` Returns all descriptors on this node in the given characteristic.
`void`	`getNativeDescriptors_inChar(java.util.UUID charUuid, ForEach_Breakable<BleDescriptor> forEach)` Overload of `getNativeDescriptors_inChar(UUID)` using a for each construct.
`void`	`getNativeDescriptors_inChar(java.util.UUID charUuid, ForEach_Void<BleDescriptor> forEach)` Overload of `getNativeDescriptors_inChar(UUID)` using a for each construct.
`java.util.List<BleDescriptor>`	`getNativeDescriptors_inService_List(java.util.UUID serviceUuid)` Returns all descriptors on this node in the given service as a list.
`java.util.Iterator<BleDescriptor>`	`getNativeDescriptors_inService(java.util.UUID serviceUuid)` Returns all descriptors on this node in the given service.
`void`	`getNativeDescriptors_inService(java.util.UUID serviceUuid, ForEach_Breakable<BleDescriptor> forEach)` Overload of `getNativeDescriptors_inService(UUID)` using a for each construct.
`void`	`getNativeDescriptors_inService(java.util.UUID serviceUuid, ForEach_Void<BleDescriptor> forEach)` Overload of `getNativeDescriptors_inService(UUID)` using a for each construct.
`java.util.List<BleDescriptor>`	`getNativeDescriptors_List()` Returns all descriptors on this node as a list.
`java.util.List<BleDescriptor>`	`getNativeDescriptors_List(java.util.UUID serviceUuid, java.util.UUID charUuid)` Returns all descriptors on this node in the given characteristic as a list.
`java.util.Iterator<BleDescriptor>`	`getNativeDescriptors()` Returns all descriptors on this node.
`void`	`getNativeDescriptors(ForEach_Breakable<BleDescriptor> forEach)` Overload of `getNativeDescriptors()` using a for each construct.
`void`	`getNativeDescriptors(ForEach_Void<BleDescriptor> forEach)` Overload of `getNativeDescriptors()` using a for each construct.
`java.util.Iterator<BleDescriptor>`	`getNativeDescriptors(java.util.UUID serviceUuid, java.util.UUID charUuid)` Returns all descriptors on this node in the given characteristic.
`void`	`getNativeDescriptors(java.util.UUID serviceUuid, java.util.UUID charUuid, ForEach_Breakable<BleDescriptor> forEach)` Overload of `getNativeDescriptors(UUID, UUID)` using a for each construct.
`void`	`getNativeDescriptors(java.util.UUID serviceUuid, java.util.UUID charUuid, ForEach_Void<BleDescriptor> forEach)` Overload of `getNativeDescriptors(UUID, UUID)` using a for each construct.
`java.util.List<BleService>`	`getNativeServices_List()` Convenience overload of `getNativeServices()` that returns a `List`.
`java.util.Iterator<BleService>`	`getNativeServices()` Returns all `BluetoothGattService` instances.
`void`	`getNativeServices(ForEach_Breakable<BleService> forEach)` Overload of `getNativeServices()` that uses a for each construct instead of returning an iterator.
`void`	`getNativeServices(ForEach_Void<BleService> forEach)` Overload of `getNativeServices()` that uses a for each construct instead of returning an iterator.
`HistoricalData`	`newHistoricalData(byte[] data, EpochTime epochTime)` Returns a new `HistoricalData` instance using `BleNodeConfig.historicalDataFactory` if available.
`HistoricalDataQueryListener.HistoricalDataQueryEvent`	`queryHistoricalData(java.lang.String query)` Provides a means to perform a raw SQL query on the database storing the historical data for this node.
`void`	`queryHistoricalData(java.lang.String query, HistoricalDataQueryListener listener)` Same as `queryHistoricalData(String)` but performs the query on a background thread and returns the result back on the main thread through the provided `HistoricalDataQueryListener`.
`HistoricalDataQuery.Part_Select`	`select()` Provides a way to perform a statically checked SQL query by chaining method calls.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.idevicesinc.sweetblue.utils.UsesCustomNull
isNull

- Field Detail
  - appData
```
public java.lang.Object appData
```
    Field for app to associate any data it wants with instances of this class instead of having to subclass or manage associative hash maps or something. The library does not touch or interact with this data in any way.
    
    See Also:
    
    BleManager.appData, appData
- Method Detail
  - getNativeBleDescriptor
```
public BleDescriptor getNativeBleDescriptor(java.util.UUID descUuid)
```
    Overload of getNativeBleDescriptor(UUID, UUID, UUID) that will return the first descriptor we find matching the given UUID.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattDescriptor actually exists (in other words, it will return true if we were unable to find the requested descriptor).
  - getNativeBleDescriptor_inChar
```
public BleDescriptor getNativeBleDescriptor_inChar(java.util.UUID charUuid,
                                                   java.util.UUID descUuid)
```
    Overload of getNativeBleDescriptor(UUID, UUID, UUID) that will return the first descriptor we find inside the given characteristic matching the given UUID.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattDescriptor actually exists (in other words, it will return true if we were unable to find the requested descriptor).
  - getNativeBleDescriptor_inService
```
public BleDescriptor getNativeBleDescriptor_inService(java.util.UUID serviceUuid,
                                                      java.util.UUID descUuid)
```
    Overload of getNativeBleDescriptor(UUID, UUID, UUID) that will return the first descriptor we find inside the given service matching the given UUID.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattDescriptor actually exists (in other words, it will return true if we were unable to find the requested descriptor).
  - getNativeBleDescriptor
```
public BleDescriptor getNativeBleDescriptor(java.util.UUID serviceUuid,
                                            java.util.UUID charUuid,
                                            java.util.UUID descUuid)
```
    Returns the BleDescriptor for the given UUID in case you need lower-level access.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattDescriptor actually exists (in other words, it will return true if we were unable to find the requested descriptor).
  - getNativeBleCharacteristic
```
public BleCharacteristic getNativeBleCharacteristic(java.util.UUID charUuid)
```
    Returns the native characteristic for the given UUID in case you need lower-level access.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattCharacteristic actually exists (in other words, it will return true if we were unable to find the requested characteristic).
  - getNativeBleCharacteristic
```
public BleCharacteristic getNativeBleCharacteristic(java.util.UUID serviceUuid,
                                                    java.util.UUID charUuid)
```
    Overload of getNativeBleCharacteristic(UUID) for when you have characteristics with identical uuids under different services.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattCharacteristic actually exists (in other words, it will return true if we were unable to find the requested characteristic).
  - getNativeCharacteristic
```
public BleCharacteristic getNativeCharacteristic(java.util.UUID serviceUuid,
                                                 java.util.UUID charUuid,
                                                 DescriptorFilter descriptorFilter)
```
    Overload of getNativeBleCharacteristic(UUID, UUID) for when you have characteristics with identical uuids within the same service.
  - getNativeBleService
```
public BleService getNativeBleService(java.util.UUID serviceUuid)
```
    Returns the native service for the given UUID in case you need lower-level access.
    Note that this will never return a null instance. You need to call P_NativeGattObject.isNull() to check if the BluetoothGattService actually exists (in other words, it will return true if we were unable to find the requested service).
  - getNativeServices
```
public java.util.Iterator<BleService> getNativeServices()
```
    Returns all BluetoothGattService instances.
  - getNativeServices_List
```
public java.util.List<BleService> getNativeServices_List()
```
    Convenience overload of getNativeServices() that returns a List.
  - getNativeServices
```
public void getNativeServices(ForEach_Void<BleService> forEach)
```
    Overload of getNativeServices() that uses a for each construct instead of returning an iterator.
  - getNativeServices
```
public void getNativeServices(ForEach_Breakable<BleService> forEach)
```
    Overload of getNativeServices() that uses a for each construct instead of returning an iterator.
  - getNativeCharacteristics
```
public void getNativeCharacteristics(ForEach_Void<BleCharacteristic> forEach)
```
    Overload of getNativeCharacteristics() that uses a for each construct instead of returning an iterator.
  - getNativeCharacteristics
```
public void getNativeCharacteristics(ForEach_Breakable<BleCharacteristic> forEach)
```
    Overload of getNativeCharacteristics() that uses a for each construct instead of returning an iterator.
  - getNativeCharacteristics
```
public void getNativeCharacteristics(java.util.UUID serviceUuid,
                                     ForEach_Void<BleCharacteristic> forEach)
```
    Overload of getNativeCharacteristics(UUID) that uses a for each construct instead of returning an iterator.
  - getNativeCharacteristics
```
public void getNativeCharacteristics(java.util.UUID serviceUuid,
                                     ForEach_Breakable<BleCharacteristic> forEach)
```
    Overload of getNativeCharacteristics(UUID) that uses a for each construct instead of returning an iterator.
  - getNativeCharacteristics
```
public java.util.Iterator<BleCharacteristic> getNativeCharacteristics()
```
    Returns all BluetoothGattCharacteristic instances.
  - getNativeCharacteristics_List
```
public java.util.List<BleCharacteristic> getNativeCharacteristics_List()
```
    Convenience overload of getNativeCharacteristics() that returns a List.
  - getNativeCharacteristics
```
public java.util.Iterator<BleCharacteristic> getNativeCharacteristics(java.util.UUID serviceUuid)
```
    Same as getNativeCharacteristics() but you can filter on the service UUID.
  - getNativeCharacteristics_List
```
public java.util.List<BleCharacteristic> getNativeCharacteristics_List(java.util.UUID serviceUuid)
```
    Convenience overload of getNativeCharacteristics(UUID) that returns a List.
  - getNativeDescriptors
```
public java.util.Iterator<BleDescriptor> getNativeDescriptors()
```
    Returns all descriptors on this node.
  - getNativeDescriptors_List
```
public java.util.List<BleDescriptor> getNativeDescriptors_List()
```
    Returns all descriptors on this node as a list.
  - getNativeDescriptors_inService
```
public java.util.Iterator<BleDescriptor> getNativeDescriptors_inService(java.util.UUID serviceUuid)
```
    Returns all descriptors on this node in the given service.
  - getNativeDescriptors_inService_List
```
public java.util.List<BleDescriptor> getNativeDescriptors_inService_List(java.util.UUID serviceUuid)
```
    Returns all descriptors on this node in the given service as a list.
  - getNativeDescriptors_inChar
```
public java.util.Iterator<BleDescriptor> getNativeDescriptors_inChar(java.util.UUID charUuid)
```
    Returns all descriptors on this node in the given characteristic.
  - getNativeDescriptors_inChar_List
```
public java.util.List<BleDescriptor> getNativeDescriptors_inChar_List(java.util.UUID charUuid)
```
    Returns all descriptors on this node in the given characteristic as a list.
  - getNativeDescriptors
```
public java.util.Iterator<BleDescriptor> getNativeDescriptors(java.util.UUID serviceUuid,
                                                              java.util.UUID charUuid)
```
    Returns all descriptors on this node in the given characteristic.
  - getNativeDescriptors_List
```
public java.util.List<BleDescriptor> getNativeDescriptors_List(java.util.UUID serviceUuid,
                                                               java.util.UUID charUuid)
```
    Returns all descriptors on this node in the given characteristic as a list.
  - getNativeDescriptors
```
public void getNativeDescriptors(ForEach_Void<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors() using a for each construct.
  - getNativeDescriptors
```
public void getNativeDescriptors(ForEach_Breakable<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors() using a for each construct.
  - getNativeDescriptors_inService
```
public void getNativeDescriptors_inService(java.util.UUID serviceUuid,
                                           ForEach_Void<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors_inService(UUID) using a for each construct.
  - getNativeDescriptors_inService
```
public void getNativeDescriptors_inService(java.util.UUID serviceUuid,
                                           ForEach_Breakable<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors_inService(UUID) using a for each construct.
  - getNativeDescriptors_inChar
```
public void getNativeDescriptors_inChar(java.util.UUID charUuid,
                                        ForEach_Void<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors_inChar(UUID) using a for each construct.
  - getNativeDescriptors_inChar
```
public void getNativeDescriptors_inChar(java.util.UUID charUuid,
                                        ForEach_Breakable<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors_inChar(UUID) using a for each construct.
  - getNativeDescriptors
```
public void getNativeDescriptors(java.util.UUID serviceUuid,
                                 java.util.UUID charUuid,
                                 ForEach_Void<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors(UUID, UUID) using a for each construct.
  - getNativeDescriptors
```
public void getNativeDescriptors(java.util.UUID serviceUuid,
                                 java.util.UUID charUuid,
                                 ForEach_Breakable<BleDescriptor> forEach)
```
    Overload of getNativeDescriptors(UUID, UUID) using a for each construct.
  - newHistoricalData
```
public HistoricalData newHistoricalData(byte[] data,
                                        EpochTime epochTime)
```
    Returns a new HistoricalData instance using BleNodeConfig.historicalDataFactory if available.
  - getManager
```
public BleManager getManager()
```
    Returns this endpoint's manager.
  - appData
```
public <T> T appData()
```
    Convenience method that casts appData for you.
  - queryHistoricalData
```
public HistoricalDataQueryListener.HistoricalDataQueryEvent queryHistoricalData(java.lang.String query)
```
    Provides a means to perform a raw SQL query on the database storing the historical data for this node. Use BleDevice.getHistoricalDataTableName(UUID) to generate table names and HistoricalDataColumn to get column names.
  - queryHistoricalData
```
public void queryHistoricalData(java.lang.String query,
                                HistoricalDataQueryListener listener)
```
    Same as queryHistoricalData(String) but performs the query on a background thread and returns the result back on the main thread through the provided HistoricalDataQueryListener.
  - select
```
public HistoricalDataQuery.Part_Select select()
```
    Provides a way to perform a statically checked SQL query by chaining method calls.
  - cast
```
public <T extends BleNode> T cast()
```
    Just some sugar for casting to subclasses.
  - cast
```
public <T extends BleNode> T cast(java.lang.Class<T> type)
```
    Safer version of cast() that will return BleDevice.NULL or BleServer.NULL if the cast cannot be made.
  - getMacAddress
```
public abstract java.lang.String getMacAddress()
```
    Returns the MAC address of the remote BleDevice or local BleServer.

Class BleNode

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.idevicesinc.sweetblue.utils.UsesCustomNull

Field Detail

appData

Method Detail

getNativeBleDescriptor

getNativeBleDescriptor_inChar

getNativeBleDescriptor_inService

getNativeBleDescriptor

getNativeBleCharacteristic

getNativeBleCharacteristic

getNativeCharacteristic

getNativeBleService

getNativeServices

getNativeServices_List

getNativeServices

getNativeServices

getNativeCharacteristics

getNativeCharacteristics

getNativeCharacteristics

getNativeCharacteristics

getNativeCharacteristics

getNativeCharacteristics_List

getNativeCharacteristics

getNativeCharacteristics_List

getNativeDescriptors

getNativeDescriptors_List

getNativeDescriptors_inService

getNativeDescriptors_inService_List

getNativeDescriptors_inChar

getNativeDescriptors_inChar_List

getNativeDescriptors

getNativeDescriptors_List

getNativeDescriptors

getNativeDescriptors

getNativeDescriptors_inService

getNativeDescriptors_inService

getNativeDescriptors_inChar

getNativeDescriptors_inChar

getNativeDescriptors

getNativeDescriptors

newHistoricalData

getManager

appData

queryHistoricalData

queryHistoricalData

select

cast

cast

getMacAddress