software.amazon.smithy.model.neighbor

Enum RelationshipDirection

java.lang.Object

java.lang.Enum<RelationshipDirection>

software.amazon.smithy.model.neighbor.RelationshipDirection

All Implemented Interfaces:

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

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

Defines the directionality of a relationship.

Enum Constant Summary

Enum Constants

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

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 Detail

values

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

Returns:

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

valueOf

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