Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Enum Class SortItem.Direction

java.lang.Object

java.lang.Enum<SortItem.Direction>

org.neo4j.cypherdsl.core.SortItem.Direction

All Implemented Interfaces:

Serializable, Comparable<SortItem.Direction>, Constable, Visitable

Enclosing class:

SortItem

@API(status=STABLE)
public static enum SortItem.Direction
extends Enum<SortItem.Direction>
implements Visitable

Sort direction.

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
ASC	Ascending order.
DESC	Descending order.
UNDEFINED	Undefined direction.

Method Summary

Modifier and Type	Method	Description
String	getSymbol()
String	toString()	Most visitables will render themselves into a Cypher fragment preceded with the actual classname.
static SortItem.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortItem.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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.neo4j.cypherdsl.core.ast.Visitable

accept

Enum Constant Details

UNDEFINED

public static final SortItem.Direction UNDEFINED

Undefined direction.

ASC

public static final SortItem.Direction ASC

Ascending order.

DESC

public static final SortItem.Direction DESC

Descending order.

Method Details

values

public static SortItem.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 SortItem.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

getSymbol

public String getSymbol()

Returns:

The database internal symbol for a direction.

toString

public String toString()

Description copied from interface: Visitable

Most visitables will render themselves into a Cypher fragment preceded with the actual classname. The representation however is not cached - in contrast to the ones for full statements. Using toString is recommended for debugging purposes mainly, and not for production use.

The concrete classname has been prepended to help debugging and actually to discourage using fragments to build queries without explicitly rendering them, either as statement or going through the renderer on purpose.

Specified by:

toString in interface Visitable

Overrides:

toString in class Enum<SortItem.Direction>

Returns:

A string representation of this visitable formatted as Classname{cypher=value}