Module imagingbook.common

Package imagingbook.common.color.sets

Interface ColorEnumeration

All Known Implementing Classes:

BasicAwtColor, CssColor, MserColors, RalColor, SiftColors

public interface ColorEnumeration

Interface used for color enum types.

Method Summary

Modifier and Type	Method	Description
static ColorEnumeration	findColor(Color col, Class<? extends ColorEnumeration> clazz)	Searches for the specified AWT Color in the given ColorEnumeration.
Color	getColor()	Returns the enum item's Color.
static Color[]	getColors(ColorEnumeration... cols)	Returns a color subset as an array of colors for the specified ColorEnumeration items.
static Color[]	getColors(Class<? extends ColorEnumeration> clazz)	Returns an array of colors defined by the specified ColorEnumeration enum class.

Method Details

getColor

Color getColor()

Returns the enum item's Color. Example:

 Color c = BasicAwtColor.Blue.getColor();

Returns:

the item's AWT Color

getColors

static Color[] getColors(Class<? extends ColorEnumeration> clazz)

Returns an array of colors defined by the specified ColorEnumeration enum class.

 Color[] colors = ColorEnumeration.getColors(BasicAwtColor.class);

Parameters:

clazz - a ColorEnumeration enum class

Returns:

a Color array

getColors

static Color[] getColors(ColorEnumeration... cols)

Returns a color subset as an array of colors for the specified ColorEnumeration items. Example:

 Color[] colors = ColorEnumeration.getColors(BasicAwtColor.Blue, BasicAwtColor.Green);

Parameters:

cols - a sequence of ColorEnumeration items

Returns:

a Color array

findColor

static ColorEnumeration findColor(Color col,
 Class<? extends ColorEnumeration> clazz)

Searches for the specified AWT Color in the given ColorEnumeration. If a matching color is found, the associated enum item is returned, null otherwise.

Parameters:

col - some AWT Color

clazz - a ColorEnumeration enum class

Returns:

a ColorEnumeration instance or null