Class HelpHandler

  • All Implemented Interfaces:
    CommandLineHandler

    public class HelpHandler
    extends java.lang.Object
    implements CommandLineHandler
    The handler processes a help command from the command string
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String[] ARG_NAMES  
    • Constructor Summary

      Constructors 
      Constructor Description
      HelpHandler()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Get the description of the key (it will be printed into the help text)
      java.lang.String getKeyName()
      Get the key name for the handler
      boolean processCommandLineKey​(java.lang.String key, PreprocessorContext context)
      Process a command line key
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • ARG_NAMES

        private static final java.lang.String[] ARG_NAMES
    • Constructor Detail

      • HelpHandler

        public HelpHandler()
    • Method Detail

      • getDescription

        public java.lang.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​(java.lang.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 java.lang.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