Package org.neo4j.cypherdsl.core

Class SortItem

  • All Implemented Interfaces:
    Visitable
    @API(status=EXPERIMENTAL,
     since="1.0")
public final class SortItem
extends java.lang.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 class  SortItem.Direction
      Sort direction.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(Visitor visitor)
      Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
      SortItem ascending()
      Creates a new sort item from this instance, setting the sort direction to ascending.
      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 Detail

      • ascending

        public SortItem ascending()
        Creates a new sort item from this instance, setting the sort direction to ascending.
        Returns:
        A new sort item.

      • descending

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