com.supermap.services.components.commontypes

Enum FlowDirection

java.lang.Object

java.lang.Enum<FlowDirection>

com.supermap.services.components.commontypes.FlowDirection

All Implemented Interfaces:

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

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

The tracing analysis direction enumeration.

It is used in searching the shortest path and tracing analysis. It is used to determine whether the tracing analysis is tracing upstream or downstream; or determine whether the shortest path analysis is to search the shortest path upstream or interpolate the shortest path downstream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWNSTREAM The downstream.
UPSTREAM The upstream.

Method Summary

Methods

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

UPSTREAM

public static final FlowDirection UPSTREAM

The upstream.

DOWNSTREAM

public static final FlowDirection DOWNSTREAM

The downstream.

Method Detail

values

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

Returns:

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

valueOf

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