org.josef.util

Enum CColor

java.lang.Object

java.lang.Enum<CColor>

org.josef.util.CColor

All Implemented Interfaces:

Serializable, Comparable<CColor>, Localizable, LocalizableEnumeration

public enum CColor
extends Enum<CColor>
implements LocalizableEnumeration

Enumeration of (RGB) colors.
This list is by no way exhaustive but contains at least the colors defined in Color.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK Black.
BLUE Blue.
CYAN Cyan.
DARK_GRAY Dark gray.
GRAY Gray.
GREEN Green.
LIGHT_GRAY Light gray.
MAGENTA Magenta.
ORANGE Orange.
PINK Pink.
RED Red.
WHITE White.
YELLOW Yellow.

Method Summary

Modifier and Type	Method and Description
int	getBlue() Gets the blue component of this CColor.
Serializable	getCode() Gets the code of this CColor which equals the name() of this CColor.
CodeDescription	getCodeDescription(Locale locale) Gets the CodeDescription of this CColor.
static List<CodeDescription>	getCodeDescriptions(Locale locale) Gets a List of CodeDescription objects for all the CColors.
String	getDescription(Locale locale) Gets the localized description of this CColor.
int	getGreen() Gets the green component of this CColor.
int	getRed() Gets the red component of this CColor.
static CColor	valueOf(String name) Returns the enum constant of this type with the specified name.
static CColor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RED

public static final CColor RED

Red.

GREEN

public static final CColor GREEN

Green.

BLUE

public static final CColor BLUE

Blue.

BLACK

public static final CColor BLACK

Black.

WHITE

public static final CColor WHITE

White.

CYAN

public static final CColor CYAN

Cyan.

DARK_GRAY

public static final CColor DARK_GRAY

Dark gray.

GRAY

public static final CColor GRAY

Gray.

LIGHT_GRAY

public static final CColor LIGHT_GRAY

Light gray.

MAGENTA

public static final CColor MAGENTA

Magenta.

ORANGE

public static final CColor ORANGE

Orange.

PINK

public static final CColor PINK

Pink.

YELLOW

public static final CColor YELLOW

Yellow.

Method Detail

values

public static CColor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CColor c : CColor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CColor valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRed

public int getRed()

Gets the red component of this CColor.

Returns:

The red component of this CColor.

getGreen

public int getGreen()

Gets the green component of this CColor.

Returns:

The green component of this CColor.

getBlue

public int getBlue()

Gets the blue component of this CColor.

Returns:

The blue component of this CColor.

getCode

public Serializable getCode()

Gets the code of this CColor which equals the name() of this CColor.

Specified by:

getCode in interface LocalizableEnumeration

Returns:

The code of this CColor.

getDescription

public String getDescription(Locale locale)

Gets the localized description of this CColor.

Specified by:

getDescription in interface Localizable

Specified by:

getDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized description of this CColor.

getCodeDescription

public CodeDescription getCodeDescription(Locale locale)

Gets the CodeDescription of this CColor.

Specified by:

getCodeDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized CodeDescription of this CColor.

getCodeDescriptions

public static List<CodeDescription> getCodeDescriptions(Locale locale)

Gets a List of CodeDescription objects for all the CColors.

Parameters:

locale - Locale used to localize the descriptions.
When null is supplied the default locale is used.

Returns:

A List of CodeDescription objects for all the CColors.