com.smartdevicelink.proxy.rpc

Class LightState

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.LightState

All Implemented Interfaces:

Cloneable

public class LightState
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_COLOR
static String	KEY_DENSITY
static String	KEY_ID
static String	KEY_STATUS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
LightState() Constructs a new LightState object
LightState(Hashtable<String,Object> hash) Constructs a new LightState object indicated by the Hashtable parameter
LightState(LightName id, LightStatus status) Constructs a newly allocated LightState object

Method Summary

Modifier and Type	Method and Description
RGBColor	getColor() Gets the color portion of the LightState class
Float	getDensity() Gets the density portion of the LightState class
LightName	getId() Gets the id portion of the LightState class
LightStatus	getStatus() Gets the status portion of the LightState class
LightState	setColor(RGBColor color) Sets the color portion of the LightState class
LightState	setDensity(Float density) Sets the density portion of the LightState class
LightState	setId(LightName id) Sets the id portion of the LightState class
LightState	setStatus(LightStatus status) Sets the status portion of the LightState 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_ID

public static final String KEY_ID

See Also:

Constant Field Values

KEY_STATUS

public static final String KEY_STATUS

See Also:

Constant Field Values

KEY_DENSITY

public static final String KEY_DENSITY

See Also:

Constant Field Values

KEY_COLOR

public static final String KEY_COLOR

See Also:

Constant Field Values

Constructor Detail

LightState

public LightState()

Constructs a new LightState object

LightState

public LightState(Hashtable<String,Object> hash)

Constructs a new LightState object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

LightState

public LightState(@NonNull
                  LightName id,
                  @NonNull
                  LightStatus status)

Constructs a newly allocated LightState object

Parameters:

id - The name of a light or a group of lights.

status - Status of Light.

Method Detail

setId

public LightState setId(@NonNull
                        LightName id)

Sets the id portion of the LightState class

Parameters:

id - The name of a light or a group of lights.

getId

public LightName getId()

Gets the id portion of the LightState class

Returns:

LightName - The name of a light or a group of lights.

setStatus

public LightState setStatus(@NonNull
                            LightStatus status)

Sets the status portion of the LightState class

Parameters:

status - enum value of type LightStatus that describes the specific lights state

See Also:

LightStatus

getStatus

public LightStatus getStatus()

Gets the status portion of the LightState class

Returns:

LightStatus enum value that describes the specific lights state

See Also:

LightStatus

getDensity

public Float getDensity()

Gets the density portion of the LightState class

Returns:

a float representation of the density of the specific light state

setDensity

public LightState setDensity(Float density)

Sets the density portion of the LightState class

Parameters:

density - a float representation of the density of the specific light state

getColor

public RGBColor getColor()

Gets the color portion of the LightState class

Returns:

an RGBColor representation of the color of this specific light state

See Also:

RGBColor

setColor

public LightState setColor(RGBColor color)

Sets the color portion of the LightState class

Parameters:

color - an RGBColor representation of the color of this specific light state

See Also:

RGBColor