Interface Parameter.FirstOfBuilder
- All Superinterfaces:
AbstractBuilder<Parameter.Multi>
,Builder<Parameter.Multi,
,Parameter.FirstOfBuilder> ResettableBuilder<Parameter.Multi,
Parameter.FirstOfBuilder>
- Enclosing interface:
Parameter
public static interface Parameter.FirstOfBuilder
extends Builder<Parameter.Multi,Parameter.FirstOfBuilder>
Specifies a builder for creating a
Parameter
that returns a
parameter that concatenates all parameters into a single
parameter to be executed one by one.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Creates aParameter.Multi
from the builder.optional()
Sets that this parameter is weak optional and will be ignored if it cannot parse the next element(s).Adds a parameter that can be used to parse an argument.default Parameter.FirstOfBuilder
Adds a set ofParameter
s to this builder.default Parameter.FirstOfBuilder
Adds a set ofParameter
s to this builder.terminal()
Sets that this parameter is optional, and will be ignored if it isn't specified - but will throw an error if this is passed something to parse that it cannot parse.
-
Method Details
-
terminal
Parameter.FirstOfBuilder terminal()Sets that this parameter is optional, and will be ignored if it isn't specified - but will throw an error if this is passed something to parse that it cannot parse.- Returns:
- This builder, for chaining
-
optional
Parameter.FirstOfBuilder optional()Sets that this parameter is weak optional and will be ignored if it cannot parse the next element(s).- Returns:
- This builder, for chaining
-
or
Adds a parameter that can be used to parse an argument. Parameters are checked in the order they are added to the builder.- Parameters:
parameter
- The parameter- Returns:
- This builder, for chaining
-
orFirstOf
Adds a set ofParameter
s to this builder.The parameters will be parsed in the provided order until one succeeds.
- Parameters:
parameters
- The parameters to add- Returns:
- This builder, for chaining
-
orFirstOf
Adds a set ofParameter
s to this builder.The parameters will be parsed in the provided order until one succeeds.
- Parameters:
parameters
- The parameters to add- Returns:
- This builder, for chaining
-
build
Parameter.Multi build()Creates aParameter.Multi
from the builder.- Specified by:
build
in interfaceAbstractBuilder<Parameter.Multi>
- Returns:
- The
Parameter.Multi
-