Package software.amazon.smithy.model.neighbor

Enum Class RelationshipDirection

java.lang.Object

java.lang.Enum<RelationshipDirection>

software.amazon.smithy.model.neighbor.RelationshipDirection

All Implemented Interfaces:

Serializable, Comparable<RelationshipDirection>, Constable

public enum RelationshipDirection
extends Enum<RelationshipDirection>

Defines the directionality of a relationship.

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
DIRECTED	A directed relationship that goes from a shape to a shape that it references.
INVERTED	The relationship goes from a shape to the shape that defines a directed relationship to the shape.

Method Summary

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

DIRECTED

public static final RelationshipDirection DIRECTED

A directed relationship that goes from a shape to a shape that it references. For example, a RelationshipType.MEMBER_TARGET is a directed relationship.

INVERTED

public static final RelationshipDirection INVERTED

The relationship goes from a shape to the shape that defines a directed relationship to the shape. For example, a RelationshipType.BOUND relation is an inverted relationship.

Method Details

values

public static RelationshipDirection[] 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 RelationshipDirection 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