com.github.thomasridd.flatsy

Class FlatsyCommandLine

java.lang.Object

com.github.thomasridd.flatsy.FlatsyCommandLine

public class FlatsyCommandLine
extends Object

See

Field Summary

Fields

Modifier and Type	Field and Description
OutputStream	defaultOut

Constructor Summary

Constructors

Constructor and Description
FlatsyCommandLine() Create a new FlatsyCommandLine
FlatsyCommandLine(InputStream stream) Create a new FlatsyCommandLine and run a script of commands
FlatsyCommandLine(List<String> commands) Create a new FlatsyCommandLine and run a list of commands
FlatsyCommandLine(Path script) Create a new FlatsyCommandLine and run a script of commands
FlatsyCommandLine(String command) Create a new FlatsyCommandLine and run a command

Method Summary

Modifier and Type	Method and Description
protected boolean	applyOperation(String command) Apply an operation to the cursor currently defined by queryCommands
FlatsyCursor	cursor() Create cursor based on currently saved query commands
FlatsyCursor	cursor(List<String> commands) Create a cursor based on a command list
FlatsyCursor	cursor(Path scriptPath) Create a cursor from a saved script
static void	main(String[] args)
boolean	runCommand(String command) Build a command using flatsy command line syntax
boolean	runScript(InputStream stream) Run a sequence of script commands from stream
boolean	runScript(List<String> commands) Run a sequence of script commands
boolean	runScript(Path path) Run a sequence of script commands from file

Methods inherited from class java.lang.Object

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

Field Detail

defaultOut

public OutputStream defaultOut

Constructor Detail

FlatsyCommandLine

public FlatsyCommandLine()

Create a new FlatsyCommandLine

FlatsyCommandLine

public FlatsyCommandLine(String command)

Create a new FlatsyCommandLine and run a command

Parameters:

command - the command

FlatsyCommandLine

public FlatsyCommandLine(List<String> commands)

Create a new FlatsyCommandLine and run a list of commands

Parameters:

commands - a list of commands

FlatsyCommandLine

public FlatsyCommandLine(Path script)
                  throws IOException

Create a new FlatsyCommandLine and run a script of commands

Parameters:

script - a path to a script

Throws:

IOException - if script cannot be opened

FlatsyCommandLine

public FlatsyCommandLine(InputStream stream)

Create a new FlatsyCommandLine and run a script of commands

Parameters:

stream - a stream for script commands

Method Detail

runCommand

public boolean runCommand(String command)

Build a command using flatsy command line syntax

Parameters:

command - a Flatsy command

Returns:

true if complete

runScript

public boolean runScript(List<String> commands)

Run a sequence of script commands

Parameters:

commands - a list of Flatsy query language commands

Returns:

success

runScript

public boolean runScript(Path path)
                  throws IOException

Run a sequence of script commands from file

Parameters:

path - the file to run

Returns:

success

Throws:

IOException - if script cannot be read

runScript

public boolean runScript(InputStream stream)

Run a sequence of script commands from stream

Parameters:

stream - the input stream

Returns:

success

cursor

public FlatsyCursor cursor(Path scriptPath)
                    throws IOException

Create a cursor from a saved script

Parameters:

scriptPath - the path of the script

Returns:

a flatsy cursor

Throws:

IOException - if the script cannot be read

cursor

public FlatsyCursor cursor(List<String> commands)

Create a cursor based on a command list

Parameters:

commands - an array of commands to run

Returns:

a flatsy cursor

cursor

public FlatsyCursor cursor()

Create cursor based on currently saved query commands

Returns:

a flatsy cursor

applyOperation

protected boolean applyOperation(String command)

Apply an operation to the cursor currently defined by queryCommands

Parameters:

command - an operation in Flatsy syntax

Returns:

success

main

public static void main(String[] args)