Open topic with navigation

com.hp.lft.sdk.mobile

## Class DeviceVitalsCollectOptions

- java.lang.Object
- - com.hp.lft.sdk.mobile.DeviceVitalsCollectOptions

-     public class DeviceVitalsCollectOptions
      extends java.lang.Object

  Defines which device vitals should be collected.

- - ### Constructor Summary

    Constructor and Description
    `DeviceVitalsCollectOptions()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `static DeviceVitalsCollectOptions` | `all()` Returns a new Instance of `DeviceVitalsCollectOptions` with all collection options set to true.
    `boolean` | `isCollectCPU()` Indicates whether to collect the device CPU usage.
    `boolean` | `isCollectFreeMemory()` Indicates whether to collect the device free memory.
    `boolean` | `isCollectMemory()` Indicates whether to collect the device memory usage.
    `static DeviceVitalsCollectOptions` | `none()` Returns a new Instance of `DeviceVitalsCollectOptions` with all collection options set to false.
    `DeviceVitalsCollectOptions` | `setCollectCPU(boolean collectCPU)` Sets whether to collect the device CPU usage.
    `DeviceVitalsCollectOptions` | `setCollectFreeMemory(boolean collectFreeMemory)` Sets whether to collect the device free memory.
    `DeviceVitalsCollectOptions` | `setCollectMemory(boolean collectMemory)` Sets whether to collect the device memory usage.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DeviceVitalsCollectOptions

          public DeviceVitalsCollectOptions()

  - ### Method Detail

    - #### isCollectCPU

          public boolean isCollectCPU()

      Indicates whether to collect the device CPU usage.
      Returns:
        true if device CPU usage should be collected.

    - #### setCollectCPU

          public DeviceVitalsCollectOptions setCollectCPU(boolean collectCPU)

      Sets whether to collect the device CPU usage.
      Parameters:
        `collectCPU` - true if device CPU usage should be collected.
      Returns:
        the `DeviceVitalsCollectOptions` instance with the updated state (builder pattern).

    - #### isCollectMemory

          public boolean isCollectMemory()

      Indicates whether to collect the device memory usage.
      Returns:
        true if device memory usage should be collected.

    - #### setCollectMemory

          public DeviceVitalsCollectOptions setCollectMemory(boolean collectMemory)

      Sets whether to collect the device memory usage.
      Parameters:
        `collectMemory` - true if device memory usage should be collected.
      Returns:
        the `DeviceVitalsCollectOptions` instance with the updated state (builder pattern).

    - #### isCollectFreeMemory

          public boolean isCollectFreeMemory()

      Indicates whether to collect the device free memory.
      Returns:
        true if device free memory should be collected.

    - #### setCollectFreeMemory

          public DeviceVitalsCollectOptions setCollectFreeMemory(boolean collectFreeMemory)

      Sets whether to collect the device free memory.
      Parameters:
        `collectFreeMemory` - true if device free memory should be collected.
      Returns:
        the `DeviceVitalsCollectOptions` instance with the updated state (builder pattern).

    - #### all

          public static DeviceVitalsCollectOptions all()

      Returns a new Instance of `DeviceVitalsCollectOptions` with all collection options set to true.
      Returns:
        a new Instance of `DeviceVitalsCollectOptions` with all collection options set to true.

    - #### none

          public static DeviceVitalsCollectOptions none()

      Returns a new Instance of `DeviceVitalsCollectOptions` with all collection options set to false.
      Returns:
        a new Instance of `DeviceVitalsCollectOptions` with all collection options set to false.