Class OptionHandlerRegistry

java.lang.Object

org.kohsuke.args4j.OptionHandlerRegistry

public class OptionHandlerRegistry
extends Object

Manages the registration of option handlers. This is good for registering custom handlers for specific parameter classes not yet implemented. The registry is a singleton that can be retrieved with the getRegistry() call.

Author:

Stephan Fuhrmann

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OptionHandlerRegistry.OptionHandlerFactory	Provide custom logic for creating OptionHandler implementation.

Method Summary

Modifier and Type	Method	Description
protected OptionHandler	createOptionHandler(CmdLineParser parser, OptionDef o, Setter setter)	Creates an OptionHandler that handles the given Option annotation and the Setter instance.
static OptionHandlerRegistry	getRegistry()	Gets the option handler registry singleton instance.
void	registerHandler(Class valueType, Class<? extends OptionHandler> handlerClass)	Registers a user-defined OptionHandler class with args4j.
void	registerHandler(Class valueType, OptionHandlerRegistry.OptionHandlerFactory factory)	Registers a user-defined OptionHandler class with args4j.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getRegistry

public static OptionHandlerRegistry getRegistry()

Gets the option handler registry singleton instance.

Returns:

a shared instance of the registry.

registerHandler

public void registerHandler(Class valueType,
 Class<? extends OptionHandler> handlerClass)

Registers a user-defined OptionHandler class with args4j.

This method allows users to extend the behavior of args4j by writing their own OptionHandler implementation.

Parameters:

valueType - The specified handler is used when the field/method annotated by Option is of this type.

handlerClass - This class must have the constructor that has the same signature as OptionHandler(CmdLineParser, OptionDef, Setter)

Throws:

NullPointerException - if valueType or handlerClass is null.

IllegalArgumentException - if handlerClass is not a subtype of OptionHandler.

registerHandler

public void registerHandler(Class valueType,
 OptionHandlerRegistry.OptionHandlerFactory factory)

Registers a user-defined OptionHandler class with args4j.

This method allows users to extend the behavior of args4j by writing their own OptionHandler implementation.

Parameters:

valueType - The specified handler is used when the field/method annotated by Option is of this type.

factory - Factory to instantiate handler upon request.

Throws:

NullPointerException - if valueType or factory is null.

createOptionHandler

protected OptionHandler createOptionHandler(CmdLineParser parser,
 OptionDef o,
 Setter setter)

Creates an OptionHandler that handles the given Option annotation and the Setter instance.