Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.utilitynetworks

Enum Class UtilityRuleType

java.lang.Object

java.lang.Enum<UtilityRuleType>

com.esri.arcgisruntime.utilitynetworks.UtilityRuleType

All Implemented Interfaces:

Serializable, Comparable<UtilityRuleType>, Constable

public enum UtilityRuleType
extends Enum<UtilityRuleType>

An enumeration of the various types of network rules that determine permissible feature associations in a utility network.

Since:

200.1.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACHMENT	A network rule governing structural attachment.
CONTAINMENT	A network rule governing containment.
EDGE_JUNCTION_EDGE_CONNECTIVITY	A network rule governing connectivity between two edges and a junction.
JUNCTION_EDGE_CONNECTIVITY	A network rule governing line-end connectivity to a device or junction.
JUNCTION_JUNCTION_CONNECTIVITY	A network rule governing connectivity between junction features.

Method Summary

Modifier and Type	Method	Description
static UtilityRuleType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UtilityRuleType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

JUNCTION_JUNCTION_CONNECTIVITY

public static final UtilityRuleType JUNCTION_JUNCTION_CONNECTIVITY

A network rule governing connectivity between junction features.

This connectivity network rule constrains the types of junction features that can be connected to another junction feature based on its asset type.

It supports terminal connectivity and affects UtilityAssociationType.CONNECTIVITY associations.

Since:

200.1.0

CONTAINMENT

public static final UtilityRuleType CONTAINMENT

A network rule governing containment.

Containment network rule constrains the types of features that can be contained in a given container feature based on its asset type.

The UtilityRule.getFromElement() of this network rule represents a container and the UtilityRule.getToElement() represents a content or another container if nested containment is allowed.

It does not support terminal connectivity and affects UtilityAssociationType.CONTAINMENT associations.

Since:

200.1.0

ATTACHMENT

public static final UtilityRuleType ATTACHMENT

A network rule governing structural attachment.

Structural attachment network rule constrains the types of features that can be attached to a given structure feature based on its asset type.

The UtilityRule.fromElementProperty() of this network rule represents a structure and the UtilityRule.toElementProperty() represents the attachments.

It does not support terminal connectivity and affects UtilityAssociationType.ATTACHMENT associations.

Since:

200.1.0

JUNCTION_EDGE_CONNECTIVITY

public static final UtilityRuleType JUNCTION_EDGE_CONNECTIVITY

A network rule governing line-end connectivity to a device or junction.

This connectivity network rule constrains the types of junction features that can be connected to edge features.

The UtilityRule.fromElementProperty() of this network rule represents a junction and the UtilityRule.toElementProperty() represents an edge.

It supports terminal connectivity and affects the following associations:

• UtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_FROM_SIDE, which allows a junction to be connected to the end point of an edge
• UtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_MIDSPAN, which allows a junction to be connected along the midspan of an edge
• UtilityAssociationType.JUNCTION_EDGE_OBJECT_CONNECTIVITY_TO_SIDE, which allows a junction to be connected to the start point of an edge.

Since:

200.1.0

EDGE_JUNCTION_EDGE_CONNECTIVITY

public static final UtilityRuleType EDGE_JUNCTION_EDGE_CONNECTIVITY

A network rule governing connectivity between two edges and a junction.

This connectivity network rule constrains the types of edge features that can be connected using an intermediate junction feature.

Since:

200.1.0

Method Details

values

public static UtilityRuleType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UtilityRuleType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null