Class HelpHandler

java.lang.Object
com.igormaznitsa.jcp.cmdline.HelpHandler
All Implemented Interfaces:
CommandLineHandler

public class HelpHandler extends Object implements CommandLineHandler
The handler processes a help command from the command string
  • Field Details

    • ARG_NAMES

      private static final String[] ARG_NAMES
  • Constructor Details

    • HelpHandler

      public HelpHandler()
  • Method Details

    • getDescription

      public String getDescription()
      Description copied from interface: CommandLineHandler
      Get the description of the key (it will be printed into the help text)
      Specified by:
      getDescription in interface CommandLineHandler
      Returns:
      the description as a String
    • processCommandLineKey

      public boolean processCommandLineKey(String key, PreprocessorContext context)
      Description copied from interface: CommandLineHandler
      Process a command line key
      Specified by:
      processCommandLineKey in interface CommandLineHandler
      Parameters:
      key - the command line key to be processed, must not be null
      context - the preprocessor context, must not be null
      Returns:
      true if the key has been recognized and processed else false
    • getKeyName

      public String getKeyName()
      Description copied from interface: CommandLineHandler
      Get the key name for the handler
      Specified by:
      getKeyName in interface CommandLineHandler
      Returns:
      the key name as a String, must not be null