Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class SortItem

java.lang.Object

org.neo4j.cypherdsl.core.SortItem

All Implemented Interfaces:

Visitable

@API(status=STABLE,
     since="1.0")
public final class SortItem
extends Object
implements Visitable

A sort item can be used in an ORDER BY clause and changes the order of the items being returned from a query.

Since:

1.0

Author:

Gerrit Meier, Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SortItem.Direction	Sort direction.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
@NotNull SortItem	ascending()	Creates a new sort item from this instance, setting the sort direction to ascending.
@NotNull SortItem	descending()	Creates a new sort item from this instance, setting the sort direction to descending.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

ascending

@NotNull
@Contract(pure=true)
public @NotNull SortItem ascending()

Creates a new sort item from this instance, setting the sort direction to ascending.

Returns:

A new sort item.

descending

@NotNull
@Contract(pure=true)
public @NotNull SortItem descending()

Creates a new sort item from this instance, setting the sort direction to descending.

Returns:

A new sort item.

accept

public void accept(Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor visiting this Visitable and its nested Visitables if applicable.

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor to notify, must not be null.