Package com.igormaznitsa.jcp.cmdline
Interface CommandLineHandler
- All Known Implementing Classes:
AllowWhitespaceDirectiveHandler,CareForLastNextLineCharHandler,ClearDstDirectoryHandler,CompareDestinationContentHandler,CopyFileAttributesHandler,DestinationDirectoryHandler,ExcludedFileExtensionsHandler,ExcludeFoldersHandler,FileExtensionsHandler,GlobalVariableDefiningFileHandler,GlobalVariableHandler,HelpHandler,InCharsetHandler,KeepLineHandler,OutCharsetHandler,PreserveIndentDirectiveHandler,RemoveCommentsHandler,SourceDirectoryHandler,UnknownAsFalseHandler,VerboseHandler
public interface CommandLineHandler
The interface describes a command line key handler. It is not just a handler
but it will be called for all met keys to recognize one to be processed.
-
Method Summary
Modifier and TypeMethodDescriptionGet the description of the key (it will be printed into the help text)Get the key name for the handlerbooleanprocessCommandLineKey(String key, PreprocessorContext context) Process a command line key
-
Method Details
-
getKeyName
String getKeyName()Get the key name for the handler- Returns:
- the key name as a String, must not be null
-
getDescription
String getDescription()Get the description of the key (it will be printed into the help text)- Returns:
- the description as a String
-
processCommandLineKey
Process a command line key- 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
-