Package net.hydromatic.sqllogictest

Class OptionsParser

java.lang.Object

net.hydromatic.sqllogictest.OptionsParser

public class OptionsParser
extends Object

Extensible command-line parsing.

New command-line options can be registered using registerOption(String, String, String, Function).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OptionsParser.SuppliedOptions	Description of the command-line options supplied.

Constructor Summary

Constructors

Constructor	Description
OptionsParser(boolean exit, PrintStream out, PrintStream err)	Create a fresh parser for command-line options.

Method Summary

Modifier and Type	Method	Description
OptionsParser.SuppliedOptions	getOptions()	Get the options produced after parsing the command-line options.
OptionsParser.SuppliedOptions	parse(String... argv)	Parse command-line arguments.
void	registerExecutor(String executorName, Supplier<SqlSltTestExecutor> executor)
void	registerOption(String option, @Nullable String argName, String description, Function<String,Boolean> optionArgProcessor)	Register a new command-line options.
void	setBinaryName(String binaryName)	Set the name displayed for the current program when printing usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsParser

public OptionsParser(boolean exit,
                     PrintStream out,
                     PrintStream err)

Create a fresh parser for command-line options. Calling 'parse' will actually perform the parsing of the options.

Parameters:

exit - If true call System.exit on error, otherwise just return a non-zero value.

out - Stream used for output.

err - Stream used for errors.

Method Detail

getOptions

public OptionsParser.SuppliedOptions getOptions()

Get the options produced after parsing the command-line options.

setBinaryName

public void setBinaryName(String binaryName)

Set the name displayed for the current program when printing usage.

registerOption

public void registerOption(String option,
                           @Nullable String argName,
                           String description,
                           Function<String,Boolean> optionArgProcessor)

Register a new command-line options.

Parameters:

option - String used to indicate option on the command-line.

argName - Name of option argument; null if no argument.

description - Description of this option.

optionArgProcessor - Function invoked when option is supplied. The function should return 'true' for successful option processing, and 'false' on error.

parse

public OptionsParser.SuppliedOptions parse(String... argv)

Parse command-line arguments.

If parsing fails the result has an OptionsParser.SuppliedOptions.exitCode field that is non-zero.

Returns:

A structure summarizing the result of parsing.

registerExecutor

public void registerExecutor(String executorName,
                             Supplier<SqlSltTestExecutor> executor)