gov.nih.ncats.common.cli

Interface CliOptionBuilder

All Known Subinterfaces:

BasicCliOptionBuilder

public interface CliOptionBuilder

Public interface that all Option Builder implementations implement. Created by katzelda on 6/4/19.

Method Summary

Modifier and Type	Method and Description
CliOptionBuilder	addValidation(java.util.function.Predicate<Cli> validationRule, java.util.function.Function<Cli,String> errorMessageFunction) Add an additional validation rule to this option Builder.
CliOptionBuilder	addValidation(java.util.function.Predicate<Cli> validationRule, String errorMessage) Add an additional validation rule to this option Builder.
CliOptionBuilder	setRequired(boolean isRequired) Is this Option required.

Method Detail

setRequired

CliOptionBuilder setRequired(boolean isRequired)

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

Parameters:

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

Returns:

this.

addValidation

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

Add an additional validation rule to this option Builder.

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.

Throws:

NullPointerException - if validationRule is null.

addValidation

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

Add an additional validation rule to this option Builder.

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.

Throws:

NullPointerException - if either parameter is null.