org.fugerit.java.tool

Class ToolHandlerHelper

java.lang.Object

org.fugerit.java.tool.ToolHandlerHelper

All Implemented Interfaces:

ToolHandler

Direct Known Subclasses:

CharsetCorrect

public abstract class ToolHandlerHelper
extends Object
implements ToolHandler

Basic class for the tool handler interface.

Author:

Fugerit

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXIT_KO_DEFAULT
protected static org.slf4j.Logger	logger

Fields inherited from interface org.fugerit.java.tool.ToolHandler

EXIT_OK

Constructor Summary

Constructors

Constructor and Description
ToolHandlerHelper()

Method Summary

Modifier and Type	Method and Description
String	getHelp()
int	handle(Properties params) Does the operation of this handler.
abstract int	handleWorker(Properties params) Handler worker method.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

EXIT_KO_DEFAULT

public static final int EXIT_KO_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ToolHandlerHelper

public ToolHandlerHelper()

Method Detail

handleWorker

public abstract int handleWorker(Properties params)
                          throws Exception

Handler worker method.

Parameters:

params - ths params for the tool

Returns:

exit code (0 is all ok)

Throws:

Exception - issues if problems arise

handle

public int handle(Properties params)
           throws Exception

Description copied from interface: ToolHandler

Does the operation of this handler.

Specified by:

handle in interface ToolHandler

Parameters:

params - the params

Returns:

the result code of the operation

Throws:

Exception - if issues arises

getHelp

public String getHelp()

Returns: