gov.nih.ncats.common.cli

Interface BasicCliOptionBuilder

All Superinterfaces:

CliOptionBuilder

public interface BasicCliOptionBuilder
extends CliOptionBuilder

Builder that builds a single option.

Method Summary

Modifier and Type	Method and Description
BasicCliOptionBuilder	addValidation(java.util.function.Predicate<Cli> validationRule, java.util.function.Function<Cli,String> errorMessageFunction) Add an additional validation rule to this option Builder.
BasicCliOptionBuilder	addValidation(java.util.function.Predicate<Cli> validationRule, String errorMessage) Add an additional validation rule to this option Builder.
BasicCliOptionBuilder	argName(String argName)
BasicCliOptionBuilder	description(String description)
BasicCliOptionBuilder	isFlag(boolean isFlag)
BasicCliOptionBuilder	longName(String longName)
BasicCliOptionBuilder	setRequired(boolean isRequired) Is this Option required.
BasicCliOptionBuilder	setter(java.util.function.Consumer<String> consumer)
<T extends Throwable> BasicCliOptionBuilder	setter(gov.nih.ncats.common.functions.ThrowableConsumer<String,T> consumer, java.util.function.Predicate<String> validator)
<T extends Throwable,R> BasicCliOptionBuilder	setter(gov.nih.ncats.common.functions.ThrowableFunction<String,R,T> typeConverter, gov.nih.ncats.common.functions.ThrowableConsumer<R,T> consumer, java.util.function.Predicate<R> validator)
BasicCliOptionBuilder	setToFile(java.util.function.Consumer<File> consumer)
BasicCliOptionBuilder	setToInt(java.util.function.IntConsumer consumer)

Method Detail

argName

BasicCliOptionBuilder argName(String argName)

longName

BasicCliOptionBuilder longName(String longName)

description

BasicCliOptionBuilder description(String description)

isFlag

BasicCliOptionBuilder isFlag(boolean isFlag)

setter

BasicCliOptionBuilder setter(java.util.function.Consumer<String> consumer)

setter

<T extends Throwable,R> BasicCliOptionBuilder setter(gov.nih.ncats.common.functions.ThrowableFunction<String,R,T> typeConverter,
                                                     gov.nih.ncats.common.functions.ThrowableConsumer<R,T> consumer,
                                                     java.util.function.Predicate<R> validator)

setter

<T extends Throwable> BasicCliOptionBuilder setter(gov.nih.ncats.common.functions.ThrowableConsumer<String,T> consumer,
                                                   java.util.function.Predicate<String> validator)

setToFile

BasicCliOptionBuilder setToFile(java.util.function.Consumer<File> consumer)

setToInt

BasicCliOptionBuilder setToInt(java.util.function.IntConsumer consumer)

setRequired

BasicCliOptionBuilder setRequired(boolean isRequired)

Description copied from interface: CliOptionBuilder

Is this Option required. If not called, the default is not required.

Specified by:

setRequired in interface CliOptionBuilder

Parameters:

isRequired - true if this option is required; false otherwise.

Returns:

this.

addValidation

BasicCliOptionBuilder addValidation(java.util.function.Predicate<Cli> validationRule,
                                    String errorMessage)

Description copied from interface: CliOptionBuilder

Add an additional validation rule to this option Builder.

Specified by:

addValidation in interface CliOptionBuilder

Parameters:

validationRule - A Predicate function that passes in the parsed Cli instance from a program invocation that will return true if this Cli passes this new validation rule; false otherwise. This Predicate can not be null.

errorMessage - The message to use in the new CliValidationException that will be thrown if the given predicate returns false.

Returns:

this.

addValidation

BasicCliOptionBuilder addValidation(java.util.function.Predicate<Cli> validationRule,
                                    java.util.function.Function<Cli,String> errorMessageFunction)

Description copied from interface: CliOptionBuilder

Add an additional validation rule to this option Builder.

Specified by:

addValidation in interface CliOptionBuilder

Parameters:

validationRule - A Predicate function that passes in the parsed Cli instance from a program invocation that will return true if this Cli passes this new validation rule; false otherwise. This Predicate can not be null.

errorMessageFunction - A function to generate the message to use in the new CliValidationException that will be thrown if the given predicate returns false.

Returns:

this.