com.cinchapi.concourse.lang.sort

Class OrderByState

Object

OrderState

BuildableOrderState

OrderByState

All Implemented Interfaces:

Order

public class OrderByState
extends BuildableOrderState

The OrderState that expects the next token to be a sort order, timestamp or a new key to sort by.

Field Summary

Fields inherited from class OrderState

order

Method Summary

Modifier and Type	Method and Description
BuiltOrder	$order() Return the BuiltOrder that is being constructed.
default OrderDirectionState	ascending() Add the Direction.ASCENDING direction to the last key that was specified in BuiltOrder that is building
OrderAtState	at(Timestamp timestamp)
default OrderDirectionState	decreasing() Alias for descending().
default OrderDirectionState	descending() Add the Direction.DESCENDING direction to the last key that was specified in BuiltOrder that is building
default OrderDirectionState	increasing() Alias for ascending().
default OrderDirectionState	largestFirst() Alias for descending().
default OrderDirectionState	largestLast() Alias for ascending().
default OrderDirectionState	reversed() Alias for descending().
default OrderDirectionState	smallestFirst() Alias for ascending().
default OrderDirectionState	smallestLast() Alias for descending().
OrderThenState	then() Transition to a state where a new key can be added.
default OrderByState	then(String key) Shortcut for calling then() immediately followed by OrderThenState.by(String) with the provided key.

Methods inherited from class BuildableOrderState

build, equals, hashCode, spec

Methods inherited from class Object

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

Methods inherited from interface Order

by, from, isSingular, keys, keysWithTimestamps, none

Method Detail

then

public OrderThenState then()

Transition to a state where a new key can be added.

Returns:

the builder

at

public OrderAtState at(Timestamp timestamp)

$order

public BuiltOrder $order()

Return the BuiltOrder that is being constructed.

Returns:

the BuiltOrder

then

public OrderByState then(String key)

Shortcut for calling then() immediately followed by OrderThenState.by(String) with the provided key.

Parameters:

key -

Returns:

the builder

ascending

public OrderDirectionState ascending()

Add the Direction.ASCENDING direction to the last key that was specified in BuiltOrder that is building

Returns:

the builder

decreasing

public OrderDirectionState decreasing()

Alias for descending().

Returns:

the builder

descending

public OrderDirectionState descending()

Add the Direction.DESCENDING direction to the last key that was specified in BuiltOrder that is building

Returns:

the builder

increasing

public OrderDirectionState increasing()

Alias for ascending().

Returns:

the builder

largestFirst

public OrderDirectionState largestFirst()

Alias for descending().

Returns:

the builder

largestLast

public OrderDirectionState largestLast()

Alias for ascending().

Returns:

the builder

reversed

public OrderDirectionState reversed()

Alias for descending().

Returns:

the builder

smallestFirst

public OrderDirectionState smallestFirst()

Alias for ascending().

Returns:

the builder

smallestLast

public OrderDirectionState smallestLast()

Alias for descending().

Returns:

the builder