Package com.igormaznitsa.jcp.cmdline
Class HelpHandler
java.lang.Object
com.igormaznitsa.jcp.cmdline.HelpHandler
- All Implemented Interfaces:
CommandLineHandler
The handler processes a help command from the command string
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the description of the key (it will be printed into the help text)Get the key name for the handlerboolean
processCommandLineKey
(String key, PreprocessorContext context) Process a command line key
-
Field Details
-
ARG_NAMES
-
-
Constructor Details
-
HelpHandler
public HelpHandler()
-
-
Method Details
-
getDescription
Description copied from interface:CommandLineHandler
Get the description of the key (it will be printed into the help text)- Specified by:
getDescription
in interfaceCommandLineHandler
- Returns:
- the description as a String
-
processCommandLineKey
Description copied from interface:CommandLineHandler
Process a command line key- Specified by:
processCommandLineKey
in interfaceCommandLineHandler
- Parameters:
key
- the command line key to be processed, must not be nullcontext
- the preprocessor context, must not be null- Returns:
- true if the key has been recognized and processed else false
-
getKeyName
Description copied from interface:CommandLineHandler
Get the key name for the handler- Specified by:
getKeyName
in interfaceCommandLineHandler
- Returns:
- the key name as a String, must not be null
-