org.conqat.lib.commons.assessment

Enum ETrafficLightColor

java.lang.Object

java.lang.Enum<ETrafficLightColor>

org.conqat.lib.commons.assessment.ETrafficLightColor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ETrafficLightColor>

public enum ETrafficLightColor
extends java.lang.Enum<ETrafficLightColor>

Enum for traffic light colors. Note that the order is relevant: The first Color (RED) is considered the most dominant color (see Assessment.getDominantColor()). The mapping to actual colors is defined in AssessmentUtils.getColor(ETrafficLightColor), so typically this method should be adjusted when a new constant is introduced here.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASELINE Baseline indicates a baseline entry, i.e.
GREEN Green signals the absence of errors or correctness.
ORANGE Orange is an intermediate state between RED and YELLOW.
RED Red signals errors or incompleteness.
UNKNOWN This is used if no information is available.
YELLOW Yellow signals warning or lack of control.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayText()
static ETrafficLightColor	getDominantColor(ETrafficLightColor color1, ETrafficLightColor color2) Returns the more dominant color, which is the enum literal with smaller index (as they are sorted by dominance).
java.lang.String	getHexValue()
java.lang.String	getShortDisplayText()
static java.util.List<ETrafficLightColor>	getTrafficLightColors() Returns the traffic light colors red, yellow and green in this particular order.
static ETrafficLightColor	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ETrafficLightColor[]	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 ETrafficLightColor RED

Red signals errors or incompleteness.

ORANGE

public static final ETrafficLightColor ORANGE

Orange is an intermediate state between RED and YELLOW.

YELLOW

public static final ETrafficLightColor YELLOW

Yellow signals warning or lack of control.

GREEN

public static final ETrafficLightColor GREEN

Green signals the absence of errors or correctness.

BASELINE

public static final ETrafficLightColor BASELINE

Baseline indicates a baseline entry, i.e. there has been no change compared to a given baseline and thus no color applies.

UNKNOWN

public static final ETrafficLightColor UNKNOWN

This is used if no information is available.

Method Detail

values

public static ETrafficLightColor[] 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 (ETrafficLightColor c : ETrafficLightColor.values())
    System.out.println(c);

Returns:

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

valueOf

public static ETrafficLightColor valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getDisplayText

public java.lang.String getDisplayText()

See Also:

displayText

getShortDisplayText

public java.lang.String getShortDisplayText()

See Also:

shortDisplayText

getHexValue

public java.lang.String getHexValue()

See Also:

hexValue

getDominantColor

public static ETrafficLightColor getDominantColor(ETrafficLightColor color1,
                                                  ETrafficLightColor color2)

Returns the more dominant color, which is the enum literal with smaller index (as they are sorted by dominance).

getTrafficLightColors

public static java.util.List<ETrafficLightColor> getTrafficLightColors()

Returns the traffic light colors red, yellow and green in this particular order.