de.tototec.cmdoption.handler
Interface CmdOptionHandler

All Known Implementing Classes:

AddToCollectionHandler, BooleanFieldHandler, BooleanOptionHandler, CharArrayHandler, PutIntoMapHandler, StringFieldHandler, StringMethodHandler, UrlHandler

public interface CmdOptionHandler

An Handler is needed to parse an Commandline option and to apply the parser result to the annotated field or method.

See Also:

AddToCollectionHandler, BooleanFieldHandler, BooleanOptionHandler, PutIntoMapHandler, StringFieldHandler, StringMethodHandler

Method Summary

void	applyParams(java.lang.Object config, java.lang.reflect.AccessibleObject element, java.lang.String[] args, java.lang.String optionName) Apply the option and it arguments (if any) to the field or method representing the option.
boolean	canHandle(java.lang.reflect.AccessibleObject element, int argCount) Return true if the field or method (element) with the given number of arguments (argCount) can be handled by this handler.

Method Detail

canHandle

boolean canHandle(java.lang.reflect.AccessibleObject element,
                  int argCount)

Return true if the field or method (element) with the given number of arguments (argCount) can be handled by this handler.

Parameters:

element - The field or method that represents an command line option.

argCount - The number or arguments the command line option supports.

Returns:

true if the option can be parsed and applied by this handler.

applyParams

void applyParams(java.lang.Object config,
                 java.lang.reflect.AccessibleObject element,
                 java.lang.String[] args,
                 java.lang.String optionName)
                 throws CmdOptionHandlerException

Apply the option and it arguments (if any) to the field or method representing the option.

Parameters:

config - The object containing the field or element to which the parsed values should be applied.

element - The element itself (field or method) to apply to.

args - The parsed arguments of the option.

optionName - The actual name of the currently handled option. This is only required to create good error messages.

Throws:

CmdOptionHandlerException - When the argument can not be applied to the config object.