Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
LightState

Class LightState

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Fields

KEY_ID

public static final java.lang.String KEY_ID
Constant Value
"id"

KEY_STATUS

public static final java.lang.String KEY_STATUS
Constant Value
"status"

KEY_DENSITY

public static final java.lang.String KEY_DENSITY
Constant Value
"density"

KEY_COLOR

public static final java.lang.String KEY_COLOR
Constant Value
"color"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

LightState()

Constructs a new LightState object

public LightState()

LightState( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new LightState object indicated by the Hashtable parameter

public LightState(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

LightState( LightName id, LightStatus status )

Constructs a newly allocated LightState object

public LightState(LightName id,LightStatus status)

Constructor Parameters

id
The name of a light or a group of lights.
status
Status of Light.

Methods

setId( LightName id )

Sets the id portion of the LightState class

public com.smartdevicelink.proxy.rpc.LightState setId(LightName id)

Method Parameters

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

getId()

Gets the id portion of the LightState class

public com.smartdevicelink.proxy.rpc.enums.LightName getId()

setStatus( LightStatus status )

Sets the status portion of the LightState class

public com.smartdevicelink.proxy.rpc.LightState setStatus(LightStatus status)

Method Parameters

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

getStatus()

Gets the status portion of the LightState class

public com.smartdevicelink.proxy.rpc.enums.LightStatus getStatus()

getDensity()

Gets the density portion of the LightState class

public java.lang.Float getDensity()

setDensity( Float density )

Sets the density portion of the LightState class

public com.smartdevicelink.proxy.rpc.LightState setDensity(Float density)

Method Parameters

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

getColor()

Gets the color portion of the LightState class

public com.smartdevicelink.proxy.rpc.RGBColor getColor()

setColor( RGBColor color )

Sets the color portion of the LightState class

public com.smartdevicelink.proxy.rpc.LightState setColor(RGBColor color)

Method Parameters

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

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section