org.ktc.rbutils.rb.check
Class RbCheckerUtility

java.lang.Object
  org.ktc.rbutils.rb.AbstractUtility
      org.ktc.rbutils.rb.check.RbCheckerUtility

All Implemented Interfaces:

CheckerUtility, Utility

public class RbCheckerUtility
extends AbstractUtility
implements CheckerUtility

Command line utility for ResourceBundle check.

Since:

RbUtils 0.5.0

Version:

$Revision: 1.6 $

Author:

redfish

Field Summary

static String	ERROR_MSG_FC_NBR Error mesage when more than on target generation directory is specified.
protected static String	OPTION_FC The fc option (for filechecker class name).

Fields inherited from class org.ktc.rbutils.rb.AbstractUtility

cmdLine, ERROR_MSG_EXTENSION_NBR, ERROR_MSG_ROOT_NBR, internalArgs, MSG_MISSING_REQUIRED_OPTION, OPTION_EXTENSION, OPTION_FILE, OPTION_LOG, OPTION_ROOT, options, REQUIRED_HEADER, root, SEP_LOG_OPTION, taskName

Constructor Summary

protected

RbCheckerUtility(String[] args) Creates a new instance of RbCheckerUtility.

Method Summary

protected MainProcessor	buildProcessor() Build the utility processor by parsing the user arguments.
String	getFileChecker() Parses the arguments of this utility in order to get the file checker to be used by this utility.
protected static int	mainNoExit(String[] args, PrintWriter pw) Launches the utility.
protected int	process() Launches the utility.

Methods inherited from class org.ktc.rbutils.rb.AbstractUtility

clone, getCommonOptions, getExtension, getFilesToBeProcessed, getLoggers, getRootDir, getUniqueDir, getUniqueOptionValue, parse, parseParameters, usage, usage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ktc.rbutils.rb.Utility

getExtension, getFilesToBeProcessed, getLoggers, getRootDir, parse, parseParameters, usage, usage

Field Detail

OPTION_FC

protected static final String OPTION_FC

The fc option (for filechecker class name).

See Also:

Constant Field Values

ERROR_MSG_FC_NBR

public static final String ERROR_MSG_FC_NBR

Error mesage when more than on target generation directory is specified.

See Also:

Constant Field Values

Constructor Detail

RbCheckerUtility

protected RbCheckerUtility(String[] args)

Creates a new instance of RbCheckerUtility.

Parameters:

args - the arguments to be passed to the utility.

Method Detail

getFileChecker

public String getFileChecker()
                      throws RbUtilsException

Parses the arguments of this utility in order to get the file checker to be used by this utility.

The Utility.parseParameters() method MUST have been previously called.

Specified by:

getFileChecker in interface CheckerUtility

Returns:

the file checker.

Throws:

RbUtilsException - if more than one -fc option is specified.

process

protected int process()
               throws Exception

Launches the utility. Do not display anything. Calling method should catch parsed exceptions and display messages to user.

Returns:

the number of errors that occur during the check (this does not count arguments parse error).

Throws:

Exception - if the arguments to be passed to the utility are not valid.

buildProcessor

protected MainProcessor buildProcessor()
                                throws Exception

Build the utility processor by parsing the user arguments.

Returns:

the built processor.

Throws:

Exception - if the arguments to be passed to the utility are not valid.

Since:

RbUtils 0.12

mainNoExit

protected static int mainNoExit(String[] args,
                                PrintWriter pw)

Launches the utility. Acts like the main method but does not exit.

Parameters:

args - the arguments to be passed to the utility.

pw - the Writer to be used to print messages.

Returns:

the number of error detected during generation.