com.igormaznitsa.jcp.cmdline

Interface CommandLineHandler

All Known Implementing Classes:

CareForLastNextLineCharHandler, ClearDstDirectoryHandler, CompareDestinationContentHandler, DestinationDirectoryHandler, ExcludedFileExtensionsHandler, FileExtensionsHandler, GlobalVariableDefiningFileHandler, GlobalVariableHandler, HelpHandler, InCharsetHandler, KeepLineHandler, OutCharsetHandler, RemoveCommentsHandler, SourceDirectoryHandler, 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 Type	Method and 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

Method Detail

getKeyName

java.lang.String getKeyName()

Get the key name for the handler

Returns:

the key name as a String, must not be null

getDescription

java.lang.String getDescription()

Get the description of the key (it will be printed into the help text)

Returns:

the description as a String

processCommandLineKey

boolean processCommandLineKey(java.lang.String key,
                              PreprocessorContext context)

Process a command line key

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