com.cinchapi.concourse.lang

Class GetCommand.SourceState

Object

GetCommand.SourceState

All Implemented Interfaces:

Command

Enclosing class:

GetCommand

public static final class GetCommand.SourceState
extends Object

The terminal state for a get command, reached after specifying the data source. Supports optional at, order, and page clauses.

Method Summary

Modifier and Type	Method and Description
GetCommand.SourceState	at(Timestamp timestamp) Pin this command to a historical Timestamp.
String	ccl() Return a CCL string equivalent to this Command.
String	condition() Return the raw CCL condition for this command.
Criteria	criteria() Return the Criteria.
boolean	equals(Object obj)
int	hashCode()
List<String>	keys() Return the keys for this command.
Order	order() Return the sort Order.
GetCommand.SourceState	order(Order order) Apply an Order to this command.
Page	page() Return the pagination.
GetCommand.SourceState	page(Page page) Apply pagination to this command.
List<Long>	records() Return the target records.
Timestamp	timestamp() Return the historical Timestamp.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Command

go, is, parse, parseAll, to

Method Detail

at

public GetCommand.SourceState at(Timestamp timestamp)

Pin this command to a historical Timestamp.

Parameters:

timestamp - the Timestamp

Returns:

this state for further chaining

order

public GetCommand.SourceState order(Order order)

Apply an Order to this command.

Parameters:

order - the Order

Returns:

this state for further chaining

page

public GetCommand.SourceState page(Page page)

Apply pagination to this command.

Parameters:

page - the Page

Returns:

this state for further chaining

keys

public List<String> keys()

Return the keys for this command.

Returns:

the keys, or an empty list for all keys

records

@Nullable
public List<Long> records()

Return the target records.

Returns:

the records, or null

criteria

@Nullable
public Criteria criteria()

Return the Criteria.

Returns:

the Criteria, or null

condition

@Nullable
public String condition()

Return the raw CCL condition for this command.

Returns:

the condition string, or null

timestamp

@Nullable
public Timestamp timestamp()

Return the historical Timestamp.

Returns:

the Timestamp, or null

order

@Nullable
public Order order()

Return the sort Order.

Returns:

the Order, or null

page

@Nullable
public Page page()

Return the pagination.

Returns:

the Page, or null

ccl

public String ccl()

Description copied from interface: Command

Return a CCL string equivalent to this Command.

Returns:

the CCL string

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object