com.cinchapi.concourse.lang

Interface Command

All Known Implementing Classes:

AddCommand.RecordState, AddCommand.ValueState, AuditCommand.KeyRecordRangeState, AuditCommand.KeyRecordState, AuditCommand.KeyRecordTimestampState, AuditCommand.RecordRangeState, AuditCommand.RecordState, AuditCommand.RecordTimestampState, BrowseCommand.State, CalculateCommand.State, ChronicleCommand.RangeState, ChronicleCommand.RecordState, ChronicleCommand.TimestampState, ClearCommand.RecordState, ConsolidateCommand.State, DescribeCommand.AllState, DescribeCommand.State, DiffCommand.KeyRangeState, DiffCommand.KeyRecordRangeState, DiffCommand.KeyRecordTimestampState, DiffCommand.KeyTimestampState, DiffCommand.RecordRangeState, DiffCommand.RecordTimestampState, FindCommand.ConditionState, FindOrAddCommand.ValueState, FindOrInsertCommand.JsonState, GetCommand.SourceState, HoldsCommand.State, InsertCommand.JsonState, InsertCommand.RecordState, JsonifyCommand.State, LinkCommand.DestinationState, NavigateCommand.SourceState, ReconcileCommand.ValuesState, RemoveCommand.RecordState, RevertCommand.TimestampState, SearchCommand.QueryState, SelectCommand.SourceState, SetCommand.RecordState, TraceCommand.State, UnlinkCommand.DestinationState, VerifyAndSwapCommand.SwapState, VerifyCommand.RecordState, VerifyCommand.TimestampState, VerifyOrSetCommand.RecordState

public interface Command

A Command encapsulates a complete CCL (Concourse Command Language) statement that can be rendered as a CCL string.

Commands are constructed using the fluent builder methods available from the CommandBuilder returned by to(), is(), or go(). All three entry points are interchangeable aliases — choose whichever reads most naturally for the command being constructed: to() for actions, is() for checks, and go() as an imperative. Each builder method returns a state object whose methods guide the caller through the valid parameter sequence for that command. Terminal states implement Command, so the result can be used directly without an explicit build() call.

Usage

 // Write
 Command cmd = Command.to().add("name").as("jeff").in(1);

 // Query
 Command cmd = Command.to().find(criteria).order(order);

 // Check
 Command cmd = Command.is().holds(1);

 // Imperative
 Command cmd = Command.go().ping();

 // Render
 String ccl = cmd.ccl();
 

Method Summary

Modifier and Type	Method and Description
String	ccl() Return a CCL string equivalent to this Command.
static CommandBuilder	go() Return a CommandBuilder for constructing Commands.
static CommandBuilder	is() Return a CommandBuilder for constructing Commands.
static Command	parse(String ccl) Parse a CCL command string into a Command.
static List<Command>	parseAll(String ccl) Parse a semicolon-separated CCL string into a List of typed Commands.
static CommandBuilder	to() Return a CommandBuilder for constructing Commands.

Method Detail

ccl

String ccl()

Return a CCL string equivalent to this Command.

Returns:

the CCL string

parse

static Command parse(String ccl)

Parse a CCL command string into a Command.

The provided ccl string is compiled using the ConcourseCompiler and must represent a valid command statement (e.g., "find age > 30 order by name" or "add name as jeff in 1").

Parameters:

ccl - the CCL command string to parse

Returns:

an equivalent Command

Throws:

ParseException - if the CCL string is not a valid command

parseAll

static List<Command> parseAll(String ccl)

Parse a semicolon-separated CCL string into a List of typed Commands.

Parameters:

ccl - the semicolon-separated CCL string

Returns:

a List of typed Commands

Throws:

IllegalArgumentException - if any statement in the CCL string is not a valid command

to

static CommandBuilder to()

Return a CommandBuilder for constructing Commands.

This entry point reads naturally for action commands: Command.to().add("name").as("jeff").in(1).

Returns:

a CommandBuilder

is

static CommandBuilder is()

Return a CommandBuilder for constructing Commands.

This entry point reads naturally for query and check commands: Command.is().holds(1).

Returns:

a CommandBuilder

go

static CommandBuilder go()

Return a CommandBuilder for constructing Commands.

This entry point reads naturally as an imperative: Command.go().add("name").as("jeff").in(1).

Returns:

a CommandBuilder