org.opentrafficsim.road.network.lane.object.trafficlight

Enum TrafficLightColor

java.lang.Object

java.lang.Enum<TrafficLightColor>

org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLightColor

All Implemented Interfaces:

Serializable, Comparable<TrafficLightColor>

public enum TrafficLightColor
extends Enum<TrafficLightColor>

The colors for a normal traffic light.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 6, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK Traffic light is not working.
GREEN GTU is allowed to drive.
RED GTU needs to stop.
YELLOW GTU is allowed to continue if it cannot stop anymore.

Method Summary

Modifier and Type	Method and Description
boolean	isBlack()
boolean	isGreen()
boolean	isRed()
boolean	isYellow()
static TrafficLightColor	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrafficLightColor[]	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 TrafficLightColor RED

GTU needs to stop.

YELLOW

public static final TrafficLightColor YELLOW

GTU is allowed to continue if it cannot stop anymore.

GREEN

public static final TrafficLightColor GREEN

GTU is allowed to drive.

BLACK

public static final TrafficLightColor BLACK

Traffic light is not working.

Method Detail

values

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

Returns:

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

valueOf

public static TrafficLightColor 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

isRed

public final boolean isRed()

Returns:

whether the light is red.

isYellow

public final boolean isYellow()

Returns:

whether the light is yellow.

isGreen

public final boolean isGreen()

Returns:

whether the light is green.

isBlack

public final boolean isBlack()

Returns:

whether the light is black (off).