Package org.kohsuke.args4j
Interface OptionHandlerFilter
-
- All Known Implementing Classes:
ExampleMode
public interface OptionHandlerFilter
SelectsOptionHandler
.For example, we use this to let the caller specify which options are printed, and which ones aren't.
- Author:
- Kohsuke Kawaguchi
- See Also:
CmdLineParser.printExample(OptionHandlerFilter)
,CmdLineParser.printUsage(Writer, ResourceBundle, OptionHandlerFilter)
-
-
Field Summary
Fields Modifier and Type Field Description static OptionHandlerFilter
ALL
Print all defined options in the example.static OptionHandlerFilter
PUBLIC
Print all non-hidden options.static OptionHandlerFilter
REQUIRED
Print all required options.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
select(OptionHandler o)
-
-
-
Field Detail
-
ALL
static final OptionHandlerFilter ALL
Print all defined options in the example.
-
PUBLIC
static final OptionHandlerFilter PUBLIC
Print all non-hidden options.This would only be useful with a small number of options.
-
REQUIRED
static final OptionHandlerFilter REQUIRED
Print all required options.
-
-
Method Detail
-
select
boolean select(OptionHandler o)
- Parameters:
o
- Nevernull
. Internally options (like-r
) and arguments (others) are treated uniformly asOptionHandler
. SeeOptionDef.isArgument()
to distinguish them.- Returns:
- true to choose this option, false to ignore/discard/disregard it.
-
-