com.smartdevicelink.proxy.rpc

Class LightCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.LightCapabilities

All Implemented Interfaces:

Cloneable

public class LightCapabilities
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DENSITY_AVAILABLE
static String	KEY_NAME
static String	KEY_RGB_COLOR_SPACE_AVAILABLE
static String	KEY_STATUS_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
LightCapabilities() Constructs a newly allocated LightCapabilities object
LightCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated LightCapabilities object indicated by the Hashtable parameter
LightCapabilities(LightName name) Constructs a newly allocated LightCapabilities object

Method Summary

Modifier and Type	Method and Description
Boolean	getDensityAvailable() Gets the densityAvailable portion of the LightCapabilities class
LightName	getName() Gets the name portion of the LightCapabilities class
Boolean	getRGBColorSpaceAvailable() Gets the RGBColorSpaceAvailable portion of the LightCapabilities class
Boolean	getStatusAvailable() Gets the statusAvailable portion of the LightCapabilities class
LightCapabilities	setDensityAvailable(Boolean densityAvailable) Sets the densityAvailable portion of the LightCapabilities class
LightCapabilities	setName(LightName name) Sets the name portion of the LightCapabilities class
LightCapabilities	setRGBColorSpaceAvailable(Boolean RGBColorSpaceAvailable) Sets the RGBColorSpaceAvailable portion of the LightCapabilities class
LightCapabilities	setStatusAvailable(Boolean statusAvailable) Sets the statusAvailable portion of the LightCapabilities 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_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

KEY_DENSITY_AVAILABLE

public static final String KEY_DENSITY_AVAILABLE

See Also:

Constant Field Values

KEY_RGB_COLOR_SPACE_AVAILABLE

public static final String KEY_RGB_COLOR_SPACE_AVAILABLE

See Also:

Constant Field Values

KEY_STATUS_AVAILABLE

public static final String KEY_STATUS_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

LightCapabilities

public LightCapabilities()

Constructs a newly allocated LightCapabilities object

LightCapabilities

public LightCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated LightCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

LightCapabilities

public LightCapabilities(@NonNull
                         LightName name)

Constructs a newly allocated LightCapabilities object

Parameters:

name - name of Light

Method Detail

setName

public LightCapabilities setName(@NonNull
                                 LightName name)

Sets the name portion of the LightCapabilities class

Parameters:

name - enum value of type LightName that describes the specific light

See Also:

LightName

getName

public LightName getName()

Gets the name portion of the LightCapabilities class

Returns:

LightName enum value that describes the specific light

See Also:

LightName

setDensityAvailable

public LightCapabilities setDensityAvailable(Boolean densityAvailable)

Sets the densityAvailable portion of the LightCapabilities class

Parameters:

densityAvailable - Indicates if the light's density can be set remotely (similar to a dimmer).

getDensityAvailable

public Boolean getDensityAvailable()

Gets the densityAvailable portion of the LightCapabilities class

Returns:

Boolean - Indicates if the light's density can be set remotely (similar to a dimmer).

setRGBColorSpaceAvailable

public LightCapabilities setRGBColorSpaceAvailable(Boolean RGBColorSpaceAvailable)

Sets the RGBColorSpaceAvailable portion of the LightCapabilities class

Parameters:

RGBColorSpaceAvailable - Indicates if the light's color can be set remotely by using the RGB color space.

getRGBColorSpaceAvailable

public Boolean getRGBColorSpaceAvailable()

Gets the RGBColorSpaceAvailable portion of the LightCapabilities class

Returns:

Boolean - Indicates if the light's color can be set remotely by using the RGB color space.

setStatusAvailable

public LightCapabilities setStatusAvailable(Boolean statusAvailable)

Sets the statusAvailable portion of the LightCapabilities class

Parameters:

statusAvailable - Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request.

getStatusAvailable

public Boolean getStatusAvailable()

Gets the statusAvailable portion of the LightCapabilities class

Returns:

Boolean - Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request.