A B C D E F G H I L O P R S

A

addValidation(Predicate<Cli>, String) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

addValidation(Predicate<Cli>, Function<Cli, String>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

addValidation(Predicate<Cli>, String) - Method in interface gov.nih.ncats.common.cli.CliOptionBuilder

Add an additional validation rule to this option Builder.

addValidation(Predicate<Cli>, Function<Cli, String>) - Method in interface gov.nih.ncats.common.cli.CliOptionBuilder

Add an additional validation rule to this option Builder.

addValidation(Predicate<Cli>, String) - Method in class gov.nih.ncats.common.cli.CliSpecification

Add an additional validation rule to this overall specification.

addValidation(Predicate<Cli>, Function<Cli, String>) - Method in class gov.nih.ncats.common.cli.CliSpecification

Add an additional validation rule to this overall specification.

argName(String) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

B

BasicCliOptionBuilder - Interface in gov.nih.ncats.common.cli

Builder that builds a single option.

C

Cli - Class in gov.nih.ncats.common.cli

A Parsed command line object that lets the user programmatically see what options were set and what those option values are.

CliOptionBuilder - Interface in gov.nih.ncats.common.cli

Public interface that all Option Builder implementations implement.

CliSpecification - Class in gov.nih.ncats.common.cli

Specification describing the options for a given program.

CliValidationException - Exception in gov.nih.ncats.common.cli

The passed in commandline options did not meet the validation criteria specificed by the CliSpecification.

CliValidationException(String) - Constructor for exception gov.nih.ncats.common.cli.CliValidationException

CliValidationException(Throwable) - Constructor for exception gov.nih.ncats.common.cli.CliValidationException

CliValidationException(String, Throwable) - Constructor for exception gov.nih.ncats.common.cli.CliValidationException

create(CliOptionBuilder...) - Static method in class gov.nih.ncats.common.cli.CliSpecification

Create a new CliSpecification with the given options.

createWithHelp(CliOptionBuilder...) - Static method in class gov.nih.ncats.common.cli.CliSpecification

Create a new CliSpecification with a default help option with the option name "-h" and long name "--help" along with the given other options.

D

description(String) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

description(String) - Method in class gov.nih.ncats.common.cli.CliSpecification

Sets a description to this usage to describe what this program does.

E

example(String, String) - Method in class gov.nih.ncats.common.cli.CliSpecification

Sets the footer that will be printed at the bottom of this usage.

F

footer(String) - Method in class gov.nih.ncats.common.cli.CliSpecification

Sets the footer that will be printed at the bottom of this usage.

G

generateUsage() - Method in class gov.nih.ncats.common.cli.CliSpecification

Generate the Usage String of this specification.

getOptionValue(String) - Method in class gov.nih.ncats.common.cli.Cli

gov.nih.ncats.common.cli - package gov.nih.ncats.common.cli

NCATS-COMMON-CLI is a Commandline options parser that allows complex groupings of options including radio groups.

group(CliOptionBuilder...) - Static method in class gov.nih.ncats.common.cli.CliSpecification

Create a new group of options where the specification is only valid if either all the required options in the group are present, or none of them are present.

H

hasOption(String) - Method in class gov.nih.ncats.common.cli.Cli

Does this Cli object have the given option name.

helpRequested() - Method in class gov.nih.ncats.common.cli.Cli

helpRequested(String[]) - Method in class gov.nih.ncats.common.cli.CliSpecification

Is one of these passed in arguments -h, --h, -help or --help.

I

isFlag(boolean) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

L

longName(String) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

O

option(String) - Static method in class gov.nih.ncats.common.cli.CliSpecification

Create a new BasicCliOptionBuilder that is mapped to the given option name.

P

parse(URL) - Method in class gov.nih.ncats.common.cli.CliSpecification

Parse the query parameters as a urlencoded command line arguments.

parse(String[]) - Method in class gov.nih.ncats.common.cli.CliSpecification

Parse the command line options of the given String array, often the arguments from a Main method.

programName(String) - Method in class gov.nih.ncats.common.cli.CliSpecification

Sets this program name to this usage.

R

radio(CliOptionBuilder...) - Static method in class gov.nih.ncats.common.cli.CliSpecification

Create a new Radio group of options where the specification is only valid if only one of the given options can be selected.

S

setRequired(boolean) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setRequired(boolean) - Method in interface gov.nih.ncats.common.cli.CliOptionBuilder

Is this Option required.

setter(ThrowableConsumer<String, T>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setter(ThrowableFunction<String, R, T>, ThrowableConsumer<R, T>, Predicate<R>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setter(ThrowableConsumer<String, T>, Predicate<String>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setToFile(ThrowableConsumer<File, T>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setToInt(ThrowableIntConsumer<T>) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

setToInt(ThrowableIntConsumer<T>, IntPredicate) - Method in interface gov.nih.ncats.common.cli.BasicCliOptionBuilder

A B C D E F G H I L O P R S