com.smartdevicelink.proxy.rpc

Class LightControlCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.LightControlCapabilities

All Implemented Interfaces:

Cloneable

public class LightControlCapabilities
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MODULE_INFO
static String	KEY_MODULE_NAME
static String	KEY_SUPPORTED_LIGHTS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
LightControlCapabilities() Constructs a new LightControlCapabilities object
LightControlCapabilities(Hashtable<String,Object> hash) Constructs a new LightControlCapabilities object indicated by the Hashtable parameter
LightControlCapabilities(String moduleName, List<LightCapabilities> supportedLights) Constructs a newly allocated LightControlCapabilities object

Method Summary

Modifier and Type	Method and Description
ModuleInfo	getModuleInfo() Gets a ModuleInfo of this capability
String	getModuleName() Gets the moduleName portion of the LightControlCapabilities class
List<LightCapabilities>	getSupportedLights() Gets the supportedLights portion of the LightControlCapabilities class
LightControlCapabilities	setModuleInfo(ModuleInfo info) Sets ModuleInfo for this capability
LightControlCapabilities	setModuleName(String moduleName) Sets the moduleName portion of the LightControlCapabilities class
LightControlCapabilities	setSupportedLights(List<LightCapabilities> supportedLights) Sets the supportedLights portion of the LightControlCapabilities class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MODULE_NAME

public static final String KEY_MODULE_NAME

See Also:

Constant Field Values

KEY_SUPPORTED_LIGHTS

public static final String KEY_SUPPORTED_LIGHTS

See Also:

Constant Field Values

KEY_MODULE_INFO

public static final String KEY_MODULE_INFO

See Also:

Constant Field Values

Constructor Detail

LightControlCapabilities

public LightControlCapabilities()

Constructs a new LightControlCapabilities object

LightControlCapabilities

public LightControlCapabilities(Hashtable<String,Object> hash)

Constructs a new LightControlCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

LightControlCapabilities

public LightControlCapabilities(@NonNull
                                String moduleName,
                                @NonNull
                                List<LightCapabilities> supportedLights)

Constructs a newly allocated LightControlCapabilities object

Parameters:

moduleName - short friendly name of the light control module.

supportedLights - An array of available LightCapabilities that are controllable.

Method Detail

setModuleName

public LightControlCapabilities setModuleName(@NonNull
                                              String moduleName)

Sets the moduleName portion of the LightControlCapabilities class

Parameters:

moduleName - The short friendly name of the light control module. It should not be used to identify a module by mobile application.

getModuleName

public String getModuleName()

Gets the moduleName portion of the LightControlCapabilities class

Returns:

String - The short friendly name of the light control module. It should not be used to identify a module by mobile application.

getSupportedLights

public List<LightCapabilities> getSupportedLights()

Gets the supportedLights portion of the LightControlCapabilities class

Returns:

List - An array of available LightCapabilities that are controllable.

setSupportedLights

public LightControlCapabilities setSupportedLights(@NonNull
                                                   List<LightCapabilities> supportedLights)

Sets the supportedLights portion of the LightControlCapabilities class

Parameters:

supportedLights - An array of available LightCapabilities that are controllable.

setModuleInfo

public LightControlCapabilities setModuleInfo(ModuleInfo info)

Sets ModuleInfo for this capability

Parameters:

info - the ModuleInfo to be set

getModuleInfo

public ModuleInfo getModuleInfo()

Gets a ModuleInfo of this capability

Returns:

module info of this capability