com.whizzosoftware.hobson.api.color

Class Color

java.lang.Object

com.whizzosoftware.hobson.api.color.Color

public class Color
extends java.lang.Object

A class that represents a color. The color can either be comprised of hue, saturation and brightness (for non-white colors) or color temperature and brightness (for shades of white).

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
Color(java.lang.Integer kelvin, java.lang.Integer brightness)
Color(java.lang.Integer hue, java.lang.Integer saturation, java.lang.Integer brightness) Constructor.
Color(java.lang.String s) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getBrightness() Returns the brightness of the color.
java.lang.Integer	getColorTemperature() Returns the color temperature of the color.
int	getHue() Returns the hue of the color.
int	getSaturation() Returns the saturation of the color.
boolean	isColor()
boolean	isColorTemperature()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Color

public Color(java.lang.Integer hue,
             java.lang.Integer saturation,
             java.lang.Integer brightness)

Constructor.

Parameters:

hue - the color's hue value (0-360 degrees)

saturation - the color's saturation value (0-100 percent)

brightness - the color's brightness value (0-100 percent)

Color

public Color(java.lang.Integer kelvin,
             java.lang.Integer brightness)

Color

public Color(java.lang.String s)

Constructor.

Parameters:

s - the result of a previous Color.toString()

Method Detail

getHue

public int getHue()

Returns the hue of the color.

Returns:

An integer between 0-360 (degrees)

getSaturation

public int getSaturation()

Returns the saturation of the color.

Returns:

An integer between 0-100 (percent)

getBrightness

public int getBrightness()

Returns the brightness of the color.

Returns:

An integer between 0-100 (percent)

getColorTemperature

public java.lang.Integer getColorTemperature()

Returns the color temperature of the color.

Returns:

An integer between 2500-9000 (kelvin)

isColor

public boolean isColor()

isColorTemperature

public boolean isColorTemperature()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object