Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Enum Class Relationship.Direction

java.lang.Object

java.lang.Enum<Relationship.Direction>

org.neo4j.cypherdsl.core.Relationship.Direction

All Implemented Interfaces:

Serializable, Comparable<Relationship.Direction>, Constable

Enclosing interface:

Relationship

@API(status=INTERNAL,
     since="1.0")
public static enum Relationship.Direction
extends Enum<Relationship.Direction>

While the direction in the schema package is centered around the node, the direction here is the direction between two nodes.

Since:

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
LTR	Left to right
RTL	Right to left
UNI	None

Method Summary

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

LTR

public static final Relationship.Direction LTR

Left to right

RTL

public static final Relationship.Direction RTL

Right to left

UNI

public static final Relationship.Direction UNI

None

Method Details

values

public static Relationship.Direction[] 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 Relationship.Direction 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

getSymbolLeft

@API(status=INTERNAL)
public String getSymbolLeft()

Returns:

The symbol to render on the left side of the relationship types.

getSymbolRight

@API(status=INTERNAL)
public String getSymbolRight()

Returns:

The symbol to render on the right side of the relationship types.