summaryrefslogtreecommitdiffstats
path: root/java/org/direct_bt/BluetoothGattService.java
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2021-01-25 18:44:32 +0100
committerSven Gothel <[email protected]>2021-01-25 18:44:32 +0100
commite7d892210343dc50c8978954f8daa71395584f2e (patch)
tree4d5f1dfcede30af5cad2a7afb97b535f40600a85 /java/org/direct_bt/BluetoothGattService.java
parentfeaff07f5942ee6ff2bd94e70bf140c678379490 (diff)
Java: New API Layout: Shorten named [Bluetooth -> BT], [Characteristic -> Char] etc (align naming with direct_bt == java; reduce java code footprint and too long code lines)
Diffstat (limited to 'java/org/direct_bt/BluetoothGattService.java')
-rw-r--r--java/org/direct_bt/BluetoothGattService.java161
1 files changed, 0 insertions, 161 deletions
diff --git a/java/org/direct_bt/BluetoothGattService.java b/java/org/direct_bt/BluetoothGattService.java
deleted file mode 100644
index 35d4fe9c..00000000
--- a/java/org/direct_bt/BluetoothGattService.java
+++ /dev/null
@@ -1,161 +0,0 @@
-/**
- * Author: Sven Gothel <[email protected]>
- * Copyright (c) 2020 Gothel Software e.K.
- * Copyright (c) 2020 ZAFENA AB
- *
- * Author: Andrei Vasiliu <[email protected]>
- * Copyright (c) 2016 Intel Corporation.
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-package org.direct_bt;
-
-import java.util.Iterator;
-import java.util.List;
-
-/**
- * Provides access to Bluetooth GATT characteristic. Follows the BlueZ adapter API
- * available at: http://git.kernel.org/cgit/bluetooth/bluez.git/tree/doc/gatt-api.txt
- */
-public interface BluetoothGattService extends BluetoothObject
-{
- @Override
- public BluetoothGattService clone();
-
- /** Find a BluetoothGattCharacteristic. If parameter UUID is not null,
- * the returned object will have to match it.
- * It will first check for existing objects. It will not turn on discovery
- * or connect to devices.
- * @parameter UUID optionally specify the UUID of the BluetoothGattCharacteristic you are
- * waiting for
- * @parameter timeoutMS the function will return after timeout time in milliseconds, a
- * value of zero means wait forever. If object is not found during this time null will be returned.
- * @return An object matching the UUID or null if not found before
- * timeout expires or event is canceled.
- */
- public BluetoothGattCharacteristic find(String UUID, long timeoutMS);
-
- /** Find a BluetoothGattCharacteristic. If parameter UUID is not null,
- * the returned object will have to match it.
- * It will first check for existing objects. It will not turn on discovery
- * or connect to devices.
- * @parameter UUID optionally specify the UUID of the BluetoothGattDescriptor you are
- * waiting for
- * @return An object matching the UUID or null if not found before
- * timeout expires or event is canceled.
- */
- public BluetoothGattCharacteristic find(String UUID);
-
- /* D-Bus property accessors: */
-
- /** Get the UUID of this service
- * @return The 128 byte UUID of this service, NULL if an error occurred
- */
- public String getUUID();
-
- /** Returns the device to which this service belongs to.
- * @return The device.
- */
- public BluetoothDevice getDevice();
-
- /** Returns true if this service is a primary service, false if secondary.
- * @return true if this service is a primary service, false if secondary.
- */
- public boolean getPrimary();
-
- /** Returns a list of BluetoothGattCharacteristics this service exposes.
- * @return A list of BluetoothGattCharacteristics exposed by this service
- */
- public List<BluetoothGattCharacteristic> getCharacteristics();
-
- /**
- * Adds the given {@link GATTCharacteristicListener} to the {@link BluetoothDevice}
- * and {@link BluetoothGattCharacteristic#enableNotificationOrIndication(boolean[])} for all {@link BluetoothGattCharacteristic} instances.
- * @param listener {@link GATTCharacteristicListener} to add to the {@link BluetoothDevice}.
- * It is important to have hte listener's {@link GATTCharacteristicListener#getAssociatedCharacteristic() associated characteristic} == null,
- * otherwise the listener can't be used for all characteristics.
- * @return true if successful, otherwise false
- * @throws IllegalArgumentException if listener's {@link GATTCharacteristicListener#getAssociatedCharacteristic() associated characteristic}
- * is not null.
- * @since 2.0.0
- * @implNote not implemented in tinyb.dbus
- * @see BluetoothGattCharacteristic#enableNotificationOrIndication(boolean[])
- * @see BluetoothDevice#addCharacteristicListener(GATTCharacteristicListener, BluetoothGattCharacteristic)
- */
- public static boolean addCharacteristicListenerToAll(final BluetoothDevice device, final List<BluetoothGattService> services,
- final GATTCharacteristicListener listener) {
- if( null == listener ) {
- throw new IllegalArgumentException("listener argument null");
- }
- if( null != listener.getAssociatedCharacteristic() ) {
- throw new IllegalArgumentException("listener's associated characteristic is not null");
- }
- final boolean res = device.addCharacteristicListener(listener);
- for(final Iterator<BluetoothGattService> is = services.iterator(); is.hasNext(); ) {
- final BluetoothGattService s = is.next();
- final List<BluetoothGattCharacteristic> characteristics = s.getCharacteristics();
- for(final Iterator<BluetoothGattCharacteristic> ic = characteristics.iterator(); ic.hasNext(); ) {
- ic.next().enableNotificationOrIndication(new boolean[2]);
- }
- }
- return res;
- }
-
- /**
- * Removes the given {@link GATTCharacteristicListener} from the {@link BluetoothDevice}.
- * @param listener {@link GATTCharacteristicListener} to remove from the {@link BluetoothDevice}.
- * @return true if successful, otherwise false
- * @since 2.0.0
- * @implNote not implemented in tinyb.dbus
- * @see BluetoothGattCharacteristic#configNotificationIndication(boolean, boolean, boolean[])
- * @see BluetoothDevice#removeCharacteristicListener(GATTCharacteristicListener)
- */
- public static boolean removeCharacteristicListenerFromAll(final BluetoothDevice device, final List<BluetoothGattService> services,
- final GATTCharacteristicListener listener) {
- for(final Iterator<BluetoothGattService> is = services.iterator(); is.hasNext(); ) {
- final BluetoothGattService s = is.next();
- final List<BluetoothGattCharacteristic> characteristics = s.getCharacteristics();
- for(final Iterator<BluetoothGattCharacteristic> ic = characteristics.iterator(); ic.hasNext(); ) {
- ic.next().configNotificationIndication(false /* enableNotification */, false /* enableIndication */, new boolean[2]);
- }
- }
- return device.removeCharacteristicListener(listener);
- }
-
- /**
- * Removes all {@link GATTCharacteristicListener} from the {@link BluetoothDevice}.
- * @return count of removed {@link GATTCharacteristicListener}
- * @since 2.0.0
- * @implNote not implemented in tinyb.dbus
- * @see BluetoothGattCharacteristic#configNotificationIndication(boolean, boolean, boolean[])
- * @see BluetoothDevice#removeAllCharacteristicListener()
- */
- public static int removeAllCharacteristicListener(final BluetoothDevice device, final List<BluetoothGattService> services) {
- for(final Iterator<BluetoothGattService> is = services.iterator(); is.hasNext(); ) {
- final BluetoothGattService s = is.next();
- final List<BluetoothGattCharacteristic> characteristics = s.getCharacteristics();
- for(final Iterator<BluetoothGattCharacteristic> ic = characteristics.iterator(); ic.hasNext(); ) {
- ic.next().configNotificationIndication(false /* enableNotification */, false /* enableIndication */, new boolean[2]);
- }
- }
- return device.removeAllCharacteristicListener();
- }
-}