Overview Package Class Tree Deprecated Index

java.lang.Object
- com.samsung.android.sdk.healthdata.HealthDataUnit

public abstract class HealthDataUnit
extends Object

This class represents a unified measurement unit and unit conversion.

Converting Unit

You can convert measured health data value to another unit easily with HealthDataUnit. The following example shows unit conversion with the predefined unit in the health data framework.

 public class HealthDataUnitExample {
 
     void convert() {
         double gram = HealthDataUnit.POUND.convertTo(1, HealthDataUnit.GRAM);
         // gram is 453.59237
     }

     static double convert(double source, String sourceUnit, String destUnit) {
         return HealthDataUnit.valueOf(sourceUnit).convertTo(source, destUnit);
     }  
 }

Since:: 1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static HealthDataUnit`	`CELSIUS` "C" A temperature unit
`static HealthDataUnit`	`CENTIMETER` "cm" A length unit
`static HealthDataUnit`	`FAHRENHEIT` "F" A temperature unit
`static HealthDataUnit`	`FLUID_OUNCE` "fl. oz."
`static HealthDataUnit`	`FOOT` "ft" A length unit
`static HealthDataUnit`	`GRAM` "g" A weight unit
`static HealthDataUnit`	`GRAMS_PER_DECILITER` "g/dL" A substance concentration unit
`static HealthDataUnit`	`HBA1C_PERCENT` "%" A HbA1c unit
`static HealthDataUnit`	`INCH` "in" A length unit
`static HealthDataUnit`	`KELVIN` "K" A temperature unit
`static HealthDataUnit`	`KILOGRAM` "kg" A weight unit
`static HealthDataUnit`	`KILOMETER` "km" A length unit
`static HealthDataUnit`	`KILOPASCAL` "kPa" A pressure unit
`static HealthDataUnit`	`LITER` "L" A volume unit
`static HealthDataUnit`	`METER` "m" A length unit
`static HealthDataUnit`	`MICROMOLES_PER_LITER` "umol/L" A substance concentration unit
`static HealthDataUnit`	`MILE` "mi" A length unit
`static HealthDataUnit`	`MILLIGRAMS_PER_DECILITER` "mg/dL" A substance concentration unit
`static HealthDataUnit`	`MILLILITER` "mL" A volume unit
`static HealthDataUnit`	`MILLIMETER` "mm" A length unit
`static HealthDataUnit`	`MILLIMETER_OF_MERCURY` "mmHg" A pressure unit
`static HealthDataUnit`	`MILLIMOLES_PER_LITER` "mmol/L" A substance concentration unit
`static HealthDataUnit`	`MILLIMOLES_PER_MOLE` "mmol/mol" A HbA1c unit
`static HealthDataUnit`	`POUND` "lb" A weight unit
`static HealthDataUnit`	`RANKINE` "R" A temperature unit
`static HealthDataUnit`	`YARD` "yd" A length unit

Constructor Summary

Constructors
Modifier Constructor and Description

protected HealthDataUnit()
Creates a HealthDataUnit instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static double`	`convert(double source, String sourceUnit, String destUnit)` Converts a given value for the source unit name to the destination unit name.
`double`	`convertTo(double source, HealthDataUnit destUnit)` Converts a given value from the current unit to the destination unit object.
`double`	`convertTo(double source, String destUnit)` Converts a given value from the current unit to the destination unit name.
`String`	`getUnitName()` Gets the health data unit name.
`boolean`	`isCompatible(HealthDataUnit unit)` Checks if the unit of this instance is compatible with a specified unit.
`static boolean`	`isCompatible(String source, String dest)` Checks if unit conversion is available between a source and destination unit.
`static void`	`registerDataUnit(HealthDataUnit unitObject)` Deprecated. A custom data unit is not supported.
`static HealthDataUnit`	`valueOf(String unit)` Gets the health data unit object for a given unit.

- Field Detail
  - CELSIUS
```
public static final HealthDataUnit CELSIUS
```
    "C"
    A temperature unit
    
    Since:
    
    1.0.0
  - CENTIMETER
```
public static final HealthDataUnit CENTIMETER
```
    "cm"
    A length unit
    
    Since:
    
    1.0.0
  - GRAM
```
public static final HealthDataUnit GRAM
```
    "g"
    A weight unit
    
    Since:
    
    1.0.0
  - KELVIN
```
public static final HealthDataUnit KELVIN
```
    "K"
    A temperature unit
    
    Since:
    
    1.0.0
  - KILOGRAM
```
public static final HealthDataUnit KILOGRAM
```
    "kg"
    A weight unit
    
    Since:
    
    1.0.0
  - KILOMETER
```
public static final HealthDataUnit KILOMETER
```
    "km"
    A length unit
    
    Since:
    
    1.0.0
  - METER
```
public static final HealthDataUnit METER
```
    "m"
    A length unit
    
    Since:
    
    1.0.0
  - MILLIMETER
```
public static final HealthDataUnit MILLIMETER
```
    "mm"
    A length unit
    
    Since:
    
    1.0.0
  - FAHRENHEIT
```
public static final HealthDataUnit FAHRENHEIT
```
    "F"
    A temperature unit
    
    Since:
    
    1.0.0
  - FOOT
```
public static final HealthDataUnit FOOT
```
    "ft"
    A length unit
    
    Since:
    
    1.0.0
  - INCH
```
public static final HealthDataUnit INCH
```
    "in"
    A length unit
    
    Since:
    
    1.0.0
  - MILE
```
public static final HealthDataUnit MILE
```
    "mi"
    A length unit
    
    Since:
    
    1.0.0
  - POUND
```
public static final HealthDataUnit POUND
```
    "lb"
    A weight unit
    
    Since:
    
    1.0.0
  - RANKINE
```
public static final HealthDataUnit RANKINE
```
    "R"
    A temperature unit
    
    Since:
    
    1.0.0
  - YARD
```
public static final HealthDataUnit YARD
```
    "yd"
    A length unit
    
    Since:
    
    1.0.0
  - GRAMS_PER_DECILITER
```
public static final HealthDataUnit GRAMS_PER_DECILITER
```
    "g/dL"
    A substance concentration unit
    
    Since:
    
    1.3.0
  - MILLIGRAMS_PER_DECILITER
```
public static final HealthDataUnit MILLIGRAMS_PER_DECILITER
```
    "mg/dL"
    A substance concentration unit
    
    Since:
    
    1.3.0
  - MILLIMOLES_PER_LITER
```
public static final HealthDataUnit MILLIMOLES_PER_LITER
```
    "mmol/L"
    A substance concentration unit
    
    Since:
    
    1.3.0
  - MICROMOLES_PER_LITER
```
public static final HealthDataUnit MICROMOLES_PER_LITER
```
    "umol/L"
    A substance concentration unit
    
    Since:
    
    1.3.0
  - MILLIMOLES_PER_MOLE
```
public static final HealthDataUnit MILLIMOLES_PER_MOLE
```
    "mmol/mol"
    A HbA1c unit
    
    Since:
    
    1.3.0
  - HBA1C_PERCENT
```
public static final HealthDataUnit HBA1C_PERCENT
```
    "%"
    A HbA1c unit
    
    Since:
    
    1.3.0
  - MILLIMETER_OF_MERCURY
```
public static final HealthDataUnit MILLIMETER_OF_MERCURY
```
    "mmHg"
    A pressure unit
    
    Since:
    
    1.3.0
  - KILOPASCAL
```
public static final HealthDataUnit KILOPASCAL
```
    "kPa"
    A pressure unit
    
    Since:
    
    1.3.0
  - LITER
```
public static final HealthDataUnit LITER
```
    "L"
    A volume unit
    
    Since:
    
    1.3.0
  - MILLILITER
```
public static final HealthDataUnit MILLILITER
```
    "mL"
    A volume unit
    
    Since:
    
    1.3.0
  - FLUID_OUNCE
```
public static final HealthDataUnit FLUID_OUNCE
```
    "fl. oz."
    A volume unit
    
    Since:
    
    1.3.0
- Constructor Detail
  - HealthDataUnit
```
protected HealthDataUnit()
```
    Creates a HealthDataUnit instance.
    
    Since:
    
    1.0.0
- Method Detail
  - getUnitName
```
public String getUnitName()
```
    Gets the health data unit name.
    
    Returns:
    
    String The unit name
    
    Since:
    
    1.0.0
  - valueOf
```
public static HealthDataUnit valueOf(String unit)
```
    Gets the health data unit object for a given unit.
    
    Parameters:
    
    unit - The unit name
    
    Returns:
    
    The HealthDataUnit instance to be used for unit conversion
    
    Throws:
    
    UnknownFormatConversionException - If unit conversion is not available for the given unit string
    
    Since:
    
    1.0.0
  - isCompatible
```
public boolean isCompatible(HealthDataUnit unit)
```
    Checks if the unit of this instance is compatible with a specified unit.
    
    Parameters:
    
    unit - The other unit
    
    Returns:
    
    true if the unit is compatible, or false
    
    Throws:
    
    IllegalArgumentException - If the given unit is null
    
    Since:
    
    1.0.0
  - isCompatible
```
public static boolean isCompatible(String source,
                                   String dest)
```
    Checks if unit conversion is available between a source and destination unit.
    
    Parameters:
    
    source - The source unit name
    
    dest - The destination unit name
    
    Returns:
    
    true if unit conversion is available, or false
    
    Since:
    
    1.0.0
  - convertTo
```
public double convertTo(double source,
                        HealthDataUnit destUnit)
```
    Converts a given value from the current unit to the destination unit object.
    
    Parameters:
    
    source - The value of the current unit
    
    destUnit - The destination unit for conversion
    
    Returns:
    
    The converted value for the destination unit
    
    Throws:
    
    UnknownFormatConversionException - If conversion is not available for the destination unit
    
    Since:
    
    1.0.0
  - convertTo
```
public final double convertTo(double source,
                              String destUnit)
```
    Converts a given value from the current unit to the destination unit name.
    
    Parameters:
    
    source - The value for the current unit
    
    destUnit - The destination unit name for conversion
    
    Returns:
    
    The converted value for the destination unit
    
    Throws:
    
    UnknownFormatConversionException - If conversion is not available for the destination unit
    
    IllegalArgumentException - If the given destUnit is null or contains an empty string
    
    Since:
    
    1.0.0
  - convert
```
public static double convert(double source,
                             String sourceUnit,
                             String destUnit)
```
    Converts a given value for the source unit name to the destination unit name.
    
    Parameters:
    
    source - The value for the sourceUnit
    
    sourceUnit - The source unit name
    
    destUnit - The destination unit name for conversion
    
    Returns:
    
    The converted value for the destination unit
    
    Throws:
    
    UnknownFormatConversionException - If conversion is not available for the destination unit
    
    Since:
    
    1.0.0
  - registerDataUnit
```
public static void registerDataUnit(HealthDataUnit unitObject)
```
    Deprecated. A custom data unit is not supported.
    
    Registers the custom data unit defined newly.
    
    Parameters:
    
    unitObject - The health data unit object to register
    
    Throws:
    
    IllegalArgumentException - If given unit is null or existed already
    
    Since:
    
    1.0.0

Class HealthDataUnit

Converting Unit

Field Summary

Constructor Summary

Method Summary

Field Detail

CELSIUS

CENTIMETER

GRAM

KELVIN

KILOGRAM

KILOMETER

METER

MILLIMETER

FAHRENHEIT

FOOT

INCH

MILE

POUND

RANKINE

YARD

GRAMS_PER_DECILITER

MILLIGRAMS_PER_DECILITER

MILLIMOLES_PER_LITER

MICROMOLES_PER_LITER

MILLIMOLES_PER_MOLE

HBA1C_PERCENT

MILLIMETER_OF_MERCURY

KILOPASCAL

LITER

MILLILITER

FLUID_OUNCE

Constructor Detail

HealthDataUnit

Method Detail

getUnitName

valueOf

isCompatible

isCompatible

convertTo

convertTo

convert

registerDataUnit