com.mbientlab.metawear.api.characteristic

Enum Battery

java.lang.Object

java.lang.Enum<Battery>

com.mbientlab.metawear.api.characteristic.Battery

All Implemented Interfaces:

GATT, GATT.GATTCharacteristic, java.io.Serializable, java.lang.Comparable<Battery>

public enum Battery
extends java.lang.Enum<Battery>
implements GATT.GATTCharacteristic

Enumeration of GATT characteristics specific to the battery service

Author:

Eric Tsai

See Also:

GATT.GATTService.BATTERY

Nested Class Summary

Nested classes/interfaces inherited from interface com.mbientlab.metawear.api.GATT

GATT.GATTCharacteristic, GATT.GATTService

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATTERY_LEVEL Battery level, as reported from the connected device

Method Summary

Methods

Modifier and Type	Method and Description
GATT.GATTService	gattService() Get the service the characteristic belongs to
java.util.UUID	uuid() Get the UUID of the GATT object
static Battery	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Battery[]	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

BATTERY_LEVEL

public static final Battery BATTERY_LEVEL

Battery level, as reported from the connected device

Method Detail

values

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

Returns:

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

valueOf

public static Battery 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

uuid

public java.util.UUID uuid()

Description copied from interface: GATT

Get the UUID of the GATT object

Specified by:

uuid in interface GATT

Returns:

GATT uuid

gattService

public GATT.GATTService gattService()

Description copied from interface: GATT.GATTCharacteristic

Get the service the characteristic belongs to

Specified by:

gattService in interface GATT.GATTCharacteristic

Returns:

Parent GATT service