Package com.esri.arcgisruntime.utilitynetworks

Enum UtilityMinimumStartingLocations

java.lang.Object

java.lang.Enum<UtilityMinimumStartingLocations>

com.esri.arcgisruntime.utilitynetworks.UtilityMinimumStartingLocations

All Implemented Interfaces:

Serializable, Comparable<UtilityMinimumStartingLocations>

public enum UtilityMinimumStartingLocations
extends Enum<UtilityMinimumStartingLocations>

An enumeration of the various types of minimum starting locations used in UtilityTraceParameters.

Since:

100.11.0

See Also:

UtilityTraceParameters.getStartingLocations(), UtilityNamedTraceConfiguration.getMinimumStartingLocations()

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANY	At least 2 starting points are necessary for the particular trace parameters.
ONE	At least one starting point is necessary for the particular trace parameters.

Method Summary

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

ONE

public static final UtilityMinimumStartingLocations ONE

At least one starting point is necessary for the particular trace parameters.

Traces like downstream require at least 1 starting points.

Since:

100.11.0

MANY

public static final UtilityMinimumStartingLocations MANY

At least 2 starting points are necessary for the particular trace parameters.

Traces like shortestPath require at least 2 starting points.

Since:

100.11.0

Method Detail

values

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

Returns:

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

valueOf

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