org.opentrafficsim.core.direction

Enum CompassDirection

java.lang.Object

java.lang.Enum<CompassDirection>

org.opentrafficsim.core.direction.CompassDirection

All Implemented Interfaces:

Serializable, Comparable<CompassDirection>, Direction

public enum CompassDirection
extends Enum<CompassDirection>
implements Direction

Copyright (c) 2014 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.

See for project information www.opentrafficsim.org.

The OpenTrafficSim project is distributed under the following BSD-style license:
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Delft University of Technology, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Version:

May 15, 2014

Author:

Alexander Verbraeck, Hans van Lint, Peter Knoppers, Guus Tamminga, Yufei Yuan

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
SOUTH
WEST

Method Summary

Methods

Modifier and Type	Method and Description
static CompassDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompassDirection[]	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

NORTH

public static final CompassDirection NORTH

SOUTH

public static final CompassDirection SOUTH

EAST

public static final CompassDirection EAST

WEST

public static final CompassDirection WEST

Method Detail

values

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

Returns:

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

valueOf

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