# Print output for @column tags ?>
public
final
class
Light
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.hardware.lights.Light |
Represents a logical light on the device.
Constants | |
---|---|
int |
LIGHT_CAPABILITY_BRIGHTNESS
Capability for lights that could adjust its LED brightness. |
int |
LIGHT_CAPABILITY_RGB
Capability for lights that has red, green and blue LEDs to control the light's color. |
int |
LIGHT_TYPE_INPUT
Type for lights that indicate a monochrome color LED light. |
int |
LIGHT_TYPE_MICROPHONE
Type for lights that indicate microphone usage |
int |
LIGHT_TYPE_PLAYER_ID
Type for lights that indicate a group of LED lights representing player id. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<Light> |
CREATOR
Implement the Parcelable interface |
Public methods | |
---|---|
int
|
describeContents()
Implement the Parcelable interface |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
int
|
getId()
Returns the id of the light. |
String
|
getName()
Returns the name of the light. |
int
|
getOrdinal()
Returns the ordinal of the light. |
int
|
getType()
Returns the logical type of the light. |
boolean
|
hasBrightnessControl()
Check whether the light has led brightness control. |
boolean
|
hasRgbControl()
Check whether the light has RGB led control. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Implement the Parcelable interface |
Inherited methods | |
---|---|
public static final int LIGHT_CAPABILITY_BRIGHTNESS
Capability for lights that could adjust its LED brightness. If the capability is not present the led can only be turned either on or off.
Constant Value: 1 (0x00000001)
public static final int LIGHT_CAPABILITY_RGB
Capability for lights that has red, green and blue LEDs to control the light's color.
Constant Value: 0 (0x00000000)
public static final int LIGHT_TYPE_INPUT
Type for lights that indicate a monochrome color LED light.
Constant Value: 10001 (0x00002711)
public static final int LIGHT_TYPE_MICROPHONE
Type for lights that indicate microphone usage
Constant Value: 8 (0x00000008)
public static final int LIGHT_TYPE_PLAYER_ID
Type for lights that indicate a group of LED lights representing player id. Player id lights normally present on game controllers are lights that consist of a row of LEDs. During multi-player game, the player id for the current game controller is represented by one of the LED that is lit according to its position in the row.
Constant Value: 10002 (0x00002712)
public int describeContents ()
Implement the Parcelable interface
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
obj |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public int getId ()
Returns the id of the light.
This is an opaque value used as a unique identifier for the light.
Returns | |
---|---|
int |
public String getName ()
Returns the name of the light.
Returns | |
---|---|
String |
This value cannot be null . |
public int getOrdinal ()
Returns the ordinal of the light.
This is a sort key that represents the physical order of lights on the device with the same type. In the case of multiple lights arranged in a line, for example, the ordinals could be [1, 2, 3, 4], or [0, 10, 20, 30], or any other values that have the same sort order.
Returns | |
---|---|
int |
public int getType ()
Returns the logical type of the light.
Returns | |
---|---|
int |
Value is LIGHT_TYPE_MICROPHONE , LIGHT_TYPE_INPUT , or LIGHT_TYPE_PLAYER_ID |
public boolean hasBrightnessControl ()
Check whether the light has led brightness control.
Returns | |
---|---|
boolean |
True if the hardware can control the led brightness, otherwise false. |
public boolean hasRgbControl ()
Check whether the light has RGB led control.
Returns | |
---|---|
boolean |
True if the hardware can control the RGB led, otherwise false. |
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
public void writeToParcel (Parcel dest, int flags)
Implement the Parcelable interface
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |