com.smartdevicelink.managers.lifecycle

Class SystemCapabilityManager

java.lang.Object

com.smartdevicelink.managers.lifecycle.SystemCapabilityManager

public class SystemCapabilityManager
extends Object

SystemCapabilityManager

Note: This class must be accessed through the SdlManager. Do not instantiate it by itself.

Method Summary

Modifier and Type	Method and Description
void	addOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener listener) Adds a listener to be called whenever a new capability is retrieved.
static <T> List<T>	convertToList(Object object, Class<T> classType) Converts a capability object into a list.
Object	getCapability(SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener scListener, boolean forceUpdate) Gets the capability object that corresponds to the supplied capability type by returning the currently cached value immediately (or null) as well as calling the listener immediately with the cached value, if available.
WindowCapability	getDefaultMainWindowCapability()
WindowCapability	getWindowCapability(int windowID)
boolean	isCapabilitySupported(SystemCapabilityType type) Ability to see if the connected module supports the given capability.
boolean	removeOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener listener) Removes an OnSystemCapabilityListener that was previously added
boolean	supportsSubscriptions() Checks is subscriptions are available on the connected head unit.

Methods inherited from class java.lang.Object

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

Method Detail

getWindowCapability

public WindowCapability getWindowCapability(int windowID)

getDefaultMainWindowCapability

public WindowCapability getDefaultMainWindowCapability()

isCapabilitySupported

public boolean isCapabilitySupported(SystemCapabilityType type)

Ability to see if the connected module supports the given capability. Useful to check before attempting to query for capabilities that require asynchronous calls to initialize.

Parameters:

type - the SystemCapabilityType that is to be checked

Returns:

if that capability is supported with the current, connected module

supportsSubscriptions

public boolean supportsSubscriptions()

Checks is subscriptions are available on the connected head unit.

Returns:

True if subscriptions are supported. False if not.

getCapability

public Object getCapability(SystemCapabilityType systemCapabilityType,
                            OnSystemCapabilityListener scListener,
                            boolean forceUpdate)

Gets the capability object that corresponds to the supplied capability type by returning the currently cached value immediately (or null) as well as calling the listener immediately with the cached value, if available. If not available, the listener will retrieve a new value and return that when the head unit responds. If capability is not cached, the method will return null and trigger the supplied listener when the capability becomes available

Parameters:

systemCapabilityType - type of capability desired

scListener - callback to execute upon retrieving capability

forceUpdate - flag to force getting a new fresh copy of the capability from the head unit even if it is cached

Returns:

desired capability if it is cached in the manager, otherwise returns a null object

addOnSystemCapabilityListener

public void addOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType,
                                          OnSystemCapabilityListener listener)

Adds a listener to be called whenever a new capability is retrieved. This method automatically subscribes to the supplied capability type and may call the listener multiple times if there are future updates, unlike getCapability() methods, which only call the listener one time.

Parameters:

systemCapabilityType - Type of capability desired

listener - callback to execute upon retrieving capability

removeOnSystemCapabilityListener

public boolean removeOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType,
                                                OnSystemCapabilityListener listener)

Removes an OnSystemCapabilityListener that was previously added

Parameters:

systemCapabilityType - Type of capability

listener - the listener that should be removed

Returns:

boolean that represents whether the removal was successful or not

convertToList

public static <T> List<T> convertToList(Object object,
                                        Class<T> classType)

Converts a capability object into a list.

Parameters:

object - the capability that needs to be converted

classType - The class type of that should be contained in the list

Returns:

a List of capabilities if object is instance of List, otherwise it will return null.