public
static
final
class
Palette.Swatch
extends Object
java.lang.Object | |
↳ | android.support.v7.graphics.Palette.Swatch |
Represents a color swatch generated from an image's palette. The RGB color can be retrieved
by calling getRgb()
.
Public constructors | |
---|---|
Palette.Swatch(int color, int population)
|
Public methods | |
---|---|
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
int
|
getBodyTextColor()
Returns an appropriate color to use for any 'body' text which is displayed over this
|
float[]
|
getHsl()
Return this swatch's HSL values. |
int
|
getPopulation()
|
int
|
getRgb()
|
int
|
getTitleTextColor()
Returns an appropriate color to use for any 'title' text which is displayed over this
|
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Palette.Swatch (int color, int population)
Parameters | |
---|---|
color |
int
|
population |
int
|
boolean equals (Object o)
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 | |
---|---|
o |
Object :
the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
int getBodyTextColor ()
Returns an appropriate color to use for any 'body' text which is displayed over this
Palette.Swatch
's color. This color is guaranteed to have sufficient contrast.
Returns | |
---|---|
int |
float[] getHsl ()
Return this swatch's HSL values. hsv[0] is Hue [0 .. 360) hsv[1] is Saturation [0...1] hsv[2] is Lightness [0...1]
Returns | |
---|---|
float[] |
int getPopulation ()
Returns | |
---|---|
int |
the number of pixels represented by this swatch |
int getRgb ()
Returns | |
---|---|
int |
this swatch's RGB color value |
int getTitleTextColor ()
Returns an appropriate color to use for any 'title' text which is displayed over this
Palette.Swatch
's color. This color is guaranteed to have sufficient contrast.
Returns | |
---|---|
int |
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
JavaTM programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
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. |