RbUtils 0.13
A B C D E F G H I J L M N O P Q R S T U V W X

A

AbstractDefaultLogger - Class in org.ktc.rbutils.api.audit
Abstract class for file logging (plain text).
AbstractDefaultLogger(OutputStream, boolean, OutputStream, boolean) - Constructor for class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Creates a new DefaultLogger instance.
AbstractFileProcessor - Class in org.ktc.rbutils.api.audit
Abstract base class for File Processing.
AbstractFileProcessor() - Constructor for class org.ktc.rbutils.api.audit.AbstractFileProcessor
 
AbstractLocalized - Class in org.ktc.rbutils.api.i18n
An abstract implementation of the Localized interface.
AbstractLocalized() - Constructor for class org.ktc.rbutils.api.i18n.AbstractLocalized
 
AbstractMainProcessor - Class in org.ktc.rbutils.api.audit
Abstract base class for Main Processing.
AbstractMainProcessor() - Constructor for class org.ktc.rbutils.api.audit.AbstractMainProcessor
 
AbstractProcessor - Class in org.ktc.rbutils.api.audit
Adds logger functionalities to the Processor interface.
AbstractProcessor() - Constructor for class org.ktc.rbutils.api.audit.AbstractProcessor
 
AbstractRbTask - Class in org.ktc.rbutils.rb
Abstract class for RbUtils ant tasks.
AbstractRbTask() - Constructor for class org.ktc.rbutils.rb.AbstractRbTask
Instanciates a new AbstractRbTask.
AbstractRbTask.Log - Class in org.ktc.rbutils.rb
Logger for the rbUtils ant tasks.
AbstractRbTask.Log() - Constructor for class org.ktc.rbutils.rb.AbstractRbTask.Log
Instanciates a new Logger.
AbstractRbTask.LoggerType - Class in org.ktc.rbutils.rb
Enumerated attribute for ant logger type.
AbstractRbTask.LoggerType() - Constructor for class org.ktc.rbutils.rb.AbstractRbTask.LoggerType
Instanciates a new LoggerType.
AbstractUtility - Class in org.ktc.rbutils.rb
Provides common functionnalities to the command line utilities.
AbstractUtility() - Constructor for class org.ktc.rbutils.rb.AbstractUtility
 
AbstractXmlLogger - Class in org.ktc.rbutils.api.audit
Abstract class for xml logging.
AbstractXmlLogger(File) - Constructor for class org.ktc.rbutils.api.audit.AbstractXmlLogger
Constructs a new Logger.
acceptKey(String) - Method in class org.ktc.rbutils.rb.check.FileChecker
Tests whether or not the specified key should be checked.
addConsoleLogger() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Adds a ConsoleLogger to this MainProcesor.
addConsoleLogger() - Method in class org.ktc.rbutils.rb.check.MainChecker
Adds a ConsoleLogger to this MainProcesor.
addConsoleLogger() - Method in class org.ktc.rbutils.rb.generation.MainGenerator
Adds a ConsoleLogger to this MainProcesor.
addError(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Does nothing.
addError(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs a process error which was discovered on a specific file.
addError(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.ErrorCounter
Logs a process error which was discovered on a specific file.
addError(ProcessEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process error which was discovered on a specific file.
addError(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process error which was discovered on a specific file.
addError(ProcessEvent) - Method in class org.ktc.rbutils.rb.check.DefaultLogger
Does nothing.
addException(Exception) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Logs an exception which happened while processing.
addException(Exception) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs an exception which happened while processing.
addException(Exception) - Method in class org.ktc.rbutils.api.audit.ErrorCounter
Logs an exception which happened while processing.
addException(Exception) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs an exception which happened while processing.
addException(Exception) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs an exception which happened while processing.
addFiles(Collection) - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Adds a collection of files to be inspected by the checker.
addFiles(Collection) - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Adds a collection of files to be inspected by the checker.
addFileset(FileSet) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Adds a set of files (nested fileset attribute).
addInfo(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Does nothing.
addInfo(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Does nothing.
addInfo(ProcessEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process info which comes from a specific file.
addInfo(ProcessEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process info which comes from a specific file.
addLogger(Logger) - Method in class org.ktc.rbutils.api.audit.AbstractProcessor
Adds a logger to this Processor.
addLogger(Logger) - Method in interface org.ktc.rbutils.api.audit.Processor
Adds a logger to this Processor.
addLogger(AbstractRbTask.Log) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Adds an Ant Logger.
addLoggers(Collection) - Method in class org.ktc.rbutils.api.audit.AbstractProcessor
Adds a collection of loggers to this Processor.
addLoggers(Collection) - Method in interface org.ktc.rbutils.api.audit.Processor
Adds a collection of loggers to this Processor.

B

buildProcessor() - Method in class org.ktc.rbutils.rb.check.RbCheckerUtility
Build the utility processor by parsing the user arguments.

C

CheckerUtility - Interface in org.ktc.rbutils.rb.check
Base interface for Checker utility.
checkIfValuesInSync(String) - Method in class org.ktc.rbutils.rb.check.FileChecker
Checks if value in rb and properties are in sync.
checkIsRbMissing() - Method in class org.ktc.rbutils.rb.check.FileChecker
Checks if the ResourceBundle relying on the properties file exists.
checkLocalesInSync() - Method in class org.ktc.rbutils.rb.check.FileChecker
Checks if the Locale of the properties and the rb are in sync.
checkUnreachedRbKeys() - Method in class org.ktc.rbutils.rb.check.FileChecker
Checks that all keys in the resourcebundle have been reached during the check.
className - Variable in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Name of the class corresponding to the processed file.
classname - Variable in class org.ktc.rbutils.api.audit.event.FileEvent
Name of the class corresponding to the processed file.
classpath - Variable in class org.ktc.rbutils.rb.check.RbCheckerTask
Contains the classpath to be used during the check.
classResource - Variable in class org.ktc.rbutils.api.i18n.AbstractLocalized
Name of the RessourceBundle for this class.
clone(Options) - Static method in class org.ktc.rbutils.rb.AbstractUtility
Clone an Options instance.
CLOSEENDNODE - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Closing character of the end of a node.
closeError - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Close error stream after use.
closeInfo - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Close info stream after use.
CLOSENODE - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Closing character of a node.
closeStream - Variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Close output stream when process completed.
cmdLine - Variable in class org.ktc.rbutils.rb.AbstractUtility
Command line of this utility.
CommonProps - Class in org.ktc.rbutils.rb
Provides common properties for RbChecker and RbGenerator.
CommonProps() - Constructor for class org.ktc.rbutils.rb.CommonProps
Dummy constructor.
ConsoleLogger - Class in org.ktc.rbutils.rb.check
Plain logger for text output.
ConsoleLogger() - Constructor for class org.ktc.rbutils.rb.check.ConsoleLogger
Instanciates a new ConsoleLogger with the super constructor.
ConsoleLogger - Class in org.ktc.rbutils.rb.generation
Plain logger for text output.
ConsoleLogger() - Constructor for class org.ktc.rbutils.rb.generation.ConsoleLogger
Instanciates a new ConsoleLogger with the super constructor.
count - Variable in class org.ktc.rbutils.api.audit.EventCounter
Keeps track of the number of counted events.
countFiles(File, String[], boolean) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the number of files found in a directory.
createLogger(Task) - Method in class org.ktc.rbutils.rb.AbstractRbTask.Log
Creates a logger according to a task.
createLogger(String) - Method in class org.ktc.rbutils.rb.LoggerCreator
Creates a logger according to a task.
currentFilePath - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Relative path (from the root directory of the process) to the file being processed.

D

DBLEQUOT - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Double quote constant.
DEFAULT_PROPERTIES_EXTENSION - Static variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Default extension of the properties file used as source when processing files.
DEFAULT_RECURSIVE_CHECK - Static variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Default value of the recursivity on subdirectories.
DefaultLogger - Class in org.ktc.rbutils.rb.check
Plain text logger for RbChecker.
DefaultLogger(OutputStream, boolean, OutputStream, boolean) - Constructor for class org.ktc.rbutils.rb.check.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger - Class in org.ktc.rbutils.rb.generation
Plain text logger for RbGenerator.
DefaultLogger(OutputStream, boolean, OutputStream, boolean) - Constructor for class org.ktc.rbutils.rb.generation.DefaultLogger
Creates a new DefaultLogger instance for RbGenerator.
detailledMessage - Variable in class org.ktc.rbutils.api.audit.event.ProcessEvent
Adds information to the Message of this Event.
displayLocale - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Locale for results display.
doJob() - Method in class org.ktc.rbutils.rb.AbstractRbTask
Launches the check.
DOS_SEPARATOR - Static variable in class org.ktc.rbutils.api.file.FileTools
The Dos file separator String.
DOS_SEPARATOR_CHAR - Static variable in class org.ktc.rbutils.api.file.FileTools
The Dos file separator character.

E

ENCODING - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Encoding used by this logger.
equalNormalized(File, File) - Static method in class org.ktc.rbutils.api.file.FileTools
Checks whether two File are equal after both have been normalized and using the case rules of the system.
ERROR - Static variable in class org.ktc.rbutils.api.audit.MessageType
The ERROR MessageType.
ERROR_MSG_EXTENSION_NBR - Static variable in class org.ktc.rbutils.rb.AbstractUtility
Error mesage when more than one extension is specified.
ERROR_MSG_FC_NBR - Static variable in class org.ktc.rbutils.rb.check.RbCheckerUtility
Error mesage when more than on target generation directory is specified.
ERROR_MSG_GEN_NBR - Static variable in class org.ktc.rbutils.rb.generation.RbGeneratorUtility
Error mesage when more than on target generation directory is specified.
ERROR_MSG_ROOT_NBR - Static variable in class org.ktc.rbutils.rb.AbstractUtility
Error mesage when more than one root directory is specified.
ErrorCounter - Class in org.ktc.rbutils.api.audit
A logger that keeps track of errors.
ErrorCounter() - Constructor for class org.ktc.rbutils.api.audit.ErrorCounter
Create a new errors counter.
ErrorType - Class in org.ktc.rbutils.rb.check
Indicates the type of an error during a check.
ErrorType() - Constructor for class org.ktc.rbutils.rb.check.ErrorType
Instanciates a new ErrorType object.
errorWriter - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Where to write error messages.
escape(String) - Static method in class org.ktc.rbutils.rb.generation.FileGenerator
Escapes characters in order to get a String with only Unicode characters.
escapeHtml(String) - Static method in class org.ktc.rbutils.api.StringTools
Escapes characteres as super class except if the argument is null or the empty String; in this case, StringTools.HTML_NBSP is returned.
escapeKey(String) - Static method in class org.ktc.rbutils.rb.generation.FileGenerator
Escapes the dot character in the String argument into the underscore character.
EventCounter - Class in org.ktc.rbutils.api.audit
A logger that keeps track of the number of Events it recieves.
EventCounter() - Constructor for class org.ktc.rbutils.api.audit.EventCounter
Create a new errors counter.
EXCEPTION - Static variable in class org.ktc.rbutils.api.audit.MessageType
The EXCEPTION MessageType.
execute() - Method in class org.ktc.rbutils.rb.check.RbCheckerTask
execute() - Method in class org.ktc.rbutils.rb.generation.RbGeneratorTask
Launches the check.
extension - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Extension of properties file.
EXTENSION_SEPARATOR - Static variable in class org.ktc.rbutils.api.file.FileTools
The extension separator String.
EXTENSION_SEPARATOR_CHAR - Static variable in class org.ktc.rbutils.api.file.FileTools
The extension separator character.

F

failOnErrors - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Specifies whether the build will break if errors occur.
failureProperty - Variable in class org.ktc.rbutils.rb.AbstractRbTask
The name of the property to set if errors occur.
FileChecker - Class in org.ktc.rbutils.rb.check
Check a properties file against a ResourceBundle.
FileChecker(File, File) - Constructor for class org.ktc.rbutils.rb.check.FileChecker
Instanciates a new FileChecker.
FileCounter - Class in org.ktc.rbutils.api.audit
An helper implementation of the Logger interface.
FileCounter() - Constructor for class org.ktc.rbutils.api.audit.FileCounter
Constructs a new instance of FileCounter.
FileEvent - Class in org.ktc.rbutils.api.audit.event
Event that occurs on a File.
FileEvent(Object, String, Locale, String) - Constructor for class org.ktc.rbutils.api.audit.event.FileEvent
Constructs an Event that occurs on a File.
FileEvent(Object) - Constructor for class org.ktc.rbutils.api.audit.event.FileEvent
Constructs a prototypical RbEvent.
FileGenerator - Class in org.ktc.rbutils.rb.generation
Generates a Java RessourceBundle source class using a Properties file.
FileGenerator(File, File, File) - Constructor for class org.ktc.rbutils.rb.generation.FileGenerator
Instanciates a new FileGenerator.
fileLocale - Variable in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Locale of the processed file.
fileName - Variable in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Name of the processed file.
filename - Variable in class org.ktc.rbutils.api.audit.event.FileEvent
Name of the File on which this Event occurs.
FileProcessor - Interface in org.ktc.rbutils.api.audit
Base interface of the File process system.
filesAlreadyAdded - Variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Indicates that the files list is already initialized.
fileSets - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Contains the filesets to process.
filesList - Variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
List of properties files to be checked.
FileTools - Class in org.ktc.rbutils.api.file
General file manipulation utilities.
FileTools() - Constructor for class org.ktc.rbutils.api.file.FileTools
Dummy constructor.
finalizeCheckerInitialization() - Method in class org.ktc.rbutils.rb.check.MainChecker
Finalizes initialization as AbstractMainProcessor.finalizeInitialization() does and also validates the provided filechecker (class loading and extends the default class).
finalizeInitialization() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Finalizes the class initialization.
fireError(Message, String) - Method in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Notify all loggers about the errors in a file.
fireError(Message, String) - Method in interface org.ktc.rbutils.api.audit.FileProcessor
Notify all loggers about the errors in a file.
fireException(Exception) - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Notify all loggers about an Exception.
fireException(Exception) - Method in class org.ktc.rbutils.api.audit.AbstractProcessor
Notify all loggers about an Exception.
fireException(Exception) - Method in interface org.ktc.rbutils.api.audit.Processor
Notify all loggers about an Exception.
fireInformation(Message, String) - Method in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Notify all loggers about an Informaton.
fireInformation(Message, String) - Method in interface org.ktc.rbutils.api.audit.FileProcessor
Notify all loggers about an Informaton.
fireProcessEnded() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Notify all loggers about the end of the main process.
fireProcessEnded() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Notify all loggers about the end of the main process.
fireProcessFileEnded() - Method in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Notify all loggers about the end of a file processing.
fireProcessFileEnded() - Method in interface org.ktc.rbutils.api.audit.FileProcessor
Notify all loggers about the end of a file processing.
fireProcessFileStarted() - Method in class org.ktc.rbutils.api.audit.AbstractFileProcessor
Notify all loggers about the beginning of a file processing.
fireProcessFileStarted() - Method in interface org.ktc.rbutils.api.audit.FileProcessor
Notify all loggers about the beginning of a file processing.
fireProcessStarted() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Notify all loggers about the beginning of the main process.
fireProcessStarted() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Notify all loggers about the beginning of the main process.
flushAndCloseStreams() - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Flushes and closes (if asked) the info and error streams.
forceNewFile(File) - Static method in class org.ktc.rbutils.api.file.FileTools
Cleans and creates a new file in the file system.

G

GeneratorUtility - Interface in org.ktc.rbutils.rb.generation
Base interface for Generator utility.
getClassName() - Method in class org.ktc.rbutils.api.audit.event.FileEvent
Returns the name of the class corresponding to the processed file.
getCommonOptions() - Static method in class org.ktc.rbutils.rb.AbstractUtility
Returns a copy of the common options shared by all RbUtils command line utilities.
getCount() - Method in class org.ktc.rbutils.api.audit.EventCounter
Returns the number of counted events since the process started.
getDetailledMessage() - Method in class org.ktc.rbutils.api.audit.event.ProcessEvent
Returns the detailled message of this Event.
getDisplay() - Method in class org.ktc.rbutils.api.audit.MessageType
Provides a human readable display of the MessageType.
getDisplay() - Method in class org.ktc.rbutils.rb.TaskType
Provides a human readable display of the TaskType.
getEmptyLocale() - Static method in class org.ktc.rbutils.api.i18n.LocaleUtils
Returns the empty locale.
getEnum(String) - Static method in class org.ktc.rbutils.rb.LoggerType
Returns an instance of LoggerType according to a String representation.
getEnumList() - Static method in class org.ktc.rbutils.rb.LoggerType
Gets the List of LoggerType objects.
getErrorsCount() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Returns the number of errors that occur during the process.
getEventDate() - Method in class org.ktc.rbutils.api.audit.event.RbEvent
Gets the date when the event occurs.
getExtension() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Gets the extension that will be used in order to find source files in the root directory.
getExtension() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Gets the extension that will be used in order to find source files in the root directory.
getExtension() - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the arguments of this utility in order to get the extension of properties files to be used by this utility.
getExtension() - Method in interface org.ktc.rbutils.rb.Utility
Parses the arguments of this utility in order to get the extension of properties files to be used by this utility.
getFieldValue(Object, String) - Static method in class org.ktc.rbutils.api.reflect.ReflectUtils
Get the value of a field.
getFileChecker() - Method in interface org.ktc.rbutils.rb.check.CheckerUtility
Parses the arguments of this utility in order to get the file checker to be used by this utility.
getFileChecker() - Method in class org.ktc.rbutils.rb.check.RbCheckerUtility
Parses the arguments of this utility in order to get the file checker to be used by this utility.
getFileName() - Method in class org.ktc.rbutils.api.audit.event.FileEvent
Gets the name of the File on which this Event occurs.
getFiles() - Method in class org.ktc.rbutils.rb.AbstractRbTask
Scans all optional filesets to find files to check and returns the list of found files.
getFilesToBeProcessed() - Method in class org.ktc.rbutils.rb.AbstractUtility
Returns a list of properties files to be processed (-f option).
getFilesToBeProcessed() - Method in interface org.ktc.rbutils.rb.Utility
Returns a list of properties files to be processed (-f option).
getFormattedPropsValue(String) - Method in class org.ktc.rbutils.rb.check.FileChecker
Returns the formatted value of this key in the properties.
getFormattedRbKey(String) - Method in class org.ktc.rbutils.rb.check.FileChecker
Formats a key into another one whichwill be used to get the corresponding value in the rb file.
getFormattedRbValue(String) - Method in class org.ktc.rbutils.rb.check.FileChecker
Returns the formatted value of the formatted value of this key in the rb.
getFullTaskName(TaskType) - Static method in class org.ktc.rbutils.rb.CommonProps
Returns the full task name of the object.
getFullVersion() - Static method in class org.ktc.rbutils.RbUtilsHelper
Returns the full version of RbUtils.
getGenDir() - Method in interface org.ktc.rbutils.rb.generation.GeneratorUtility
Parses the arguments of this utility in order to get the generation target directory to be used by this utility.
getGenDir() - Method in class org.ktc.rbutils.rb.generation.RbGeneratorUtility
Parses the arguments of this utility in order to get the generation target directory to be used by this utility.
getHomePage() - Static method in class org.ktc.rbutils.RbUtilsHelper
Returns the project's homepage url.
getJavaRbClassName(File) - Static method in class org.ktc.rbutils.rb.generation.FileGenerator
Gets the name of the class generated from a Properties file.
getJavaRbFile(File, File, File) - Static method in class org.ktc.rbutils.rb.generation.FileGenerator
Gets the File of the Java ResourceBundle according to the relative path of a properties file from its root directory.
getLocale() - Method in class org.ktc.rbutils.api.audit.event.FileEvent
Gets the Locale of the File on which this Event occurs.
getLocale() - Static method in class org.ktc.rbutils.api.i18n.Message
Returns the locale used to display the localized message.
getLocale() - Method in class org.ktc.rbutils.api.i18n.PropertiesRB
Returns the locale of the current object.
getLocaleFrom(File) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the locale of the file according to its filename.
getLocaleFrom(String) - Static method in class org.ktc.rbutils.api.i18n.LocaleUtils
Returns the locale part of a String.
getLocalizedMessage() - Method in exception org.ktc.rbutils.api.file.NotDirectoryException
getLocalizedMessage() - Method in exception org.ktc.rbutils.api.file.NotFileException
getLocalizedMessage(String, Object[]) - Static method in class org.ktc.rbutils.rb.check.ErrorType
getLocalizedMessage(String, Object[]) - Static method in class org.ktc.rbutils.RbUtilsHelper
getLoggers() - Method in class org.ktc.rbutils.rb.AbstractRbTask
Returns the list of listeners set in this task.
getLoggers() - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the arguments of this utility in order to get the loggers to be used by this utility.
getLoggers() - Method in interface org.ktc.rbutils.rb.Utility
Parses the arguments of this utility in order to get the loggers to be used by this utility.
getLoggerType() - Method in class org.ktc.rbutils.rb.AbstractRbTask.Log
Returns the type of this ant logger.
getLoggerType() - Method in class org.ktc.rbutils.rb.LoggerCreator
Returns the type of this logger.
getMessage() - Method in exception org.ktc.rbutils.api.file.NotDirectoryException
getMessage() - Method in exception org.ktc.rbutils.api.file.NotFileException
getMessage() - Method in exception org.ktc.rbutils.api.file.NotRootParentOfFileException
getMessage(String, Object[]) - Method in class org.ktc.rbutils.api.i18n.AbstractLocalized
Creates a Message with optional MessageFormat array.
getMessage(String, Object[]) - Method in interface org.ktc.rbutils.api.i18n.Localized
Creates a Message with optional MessageFormat array.
getMessage() - Method in class org.ktc.rbutils.api.i18n.Message
Returns the message in a human localized readable format.
getMessage(String, Object[]) - Static method in class org.ktc.rbutils.rb.check.ErrorType
getMessage(String) - Static method in class org.ktc.rbutils.rb.check.ErrorType
getMessage(String, Object[]) - Static method in class org.ktc.rbutils.RbUtilsHelper
getMessage(String) - Static method in class org.ktc.rbutils.RbUtilsHelper
getMessageDisplay() - Method in class org.ktc.rbutils.api.audit.event.ProcessEvent
Returns the display form of the Message of this Event.
getMessageTypeDisplay() - Method in class org.ktc.rbutils.api.audit.event.ProcessEvent
Returns the display form of the MessageType of this Event.
getMsgWithFilePathPrefix(String) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Add the current file path to the given message.
getNameWithoutExtension(File) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the filename of a File without extension.
getNewInstance(File) - Static method in class org.ktc.rbutils.api.file.FileTools
Get a new instance of a File.
getOutputFile() - Method in class org.ktc.rbutils.rb.AbstractRbTask.Log
Returns the output file of this ant logger.
getOutputFile() - Method in class org.ktc.rbutils.rb.LoggerCreator
Returns the output file of this ant logger.
getProcessedFilesCount() - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Returns the number of processed files by this MainProcessor.
getProcessedFilesCount() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Returns the number of processed files by this MainProcessor.
getRootDir() - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the arguments of this utility in order to get the root directory to be used by this utility.
getRootDir() - Method in interface org.ktc.rbutils.rb.Utility
Parses the arguments of this utility in order to get the root directory to be used by this utility.
getRootDirectory() - Method in class org.ktc.rbutils.api.audit.event.RootEvent
 
getRunningTask(TaskType) - Static method in class org.ktc.rbutils.rb.CommonProps
Returns a displayable message that indicates the task is running.
getStrippedFileName(File, File) - Static method in class org.ktc.rbutils.api.file.FileTools
Create a stripped down version of a filename.
getStrippedFileName(File, File, boolean) - Static method in class org.ktc.rbutils.api.file.FileTools
Create a stripped down version of a filename.
getTimestamp() - Static method in class org.ktc.rbutils.RbUtilsHelper
Returns the compiled timestamp of the project.
getUniqueDir(String, String) - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the command line options in order to get a directory which must have been specified only once.
getUniqueOptionValue(String, String, boolean) - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the command line options in order to get an option value which must have been specified at most once.
getValues() - Method in class org.ktc.rbutils.rb.AbstractRbTask.LoggerType
getVersion() - Static method in class org.ktc.rbutils.RbUtilsHelper
Returns the version of the project.
getXmlHeader() - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Returns the header of an UTF-8 xml file.

H

handleErrors(int) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Handles errors.
HTML_NBSP - Static variable in class org.ktc.rbutils.api.StringTools
The html space character.

I

inferPackageClassName(File, File, boolean, boolean) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the package (if file is a directory) or class (if file is a file in the filesystem) name of a File according to its relative path from a root directory.
inferPackageClassName(File, File, boolean) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the package (if file is a directory) or class (if file is a file in the filesystem) name of a File according to its relative path from a root directory.
inferPackageName(File, File) - Static method in class org.ktc.rbutils.api.file.FileTools
Returns the package (if file is a directory) or class (if file is a file in the filesystem) name of a File according to its relative path from a root directory.
INFO - Static variable in class org.ktc.rbutils.api.audit.MessageType
The INFO MessageType.
infoWriter - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Where to write info messages.
internalArgs - Variable in class org.ktc.rbutils.rb.AbstractUtility
Internal arguments to be passed to the utility.
internalUsage() - Method in class org.ktc.rbutils.rb.content.RbContentListerUtility
Display the usage of the utility.
invokeConstructor(Class, Class[], Object[]) - Static method in class org.ktc.rbutils.api.reflect.ReflectUtils
Invokes a constructor with given arguments.
invokeMethod(Object, String, Class[], Object[]) - Static method in class org.ktc.rbutils.api.reflect.ReflectUtils
Invokes a method with given arguments on an instance of an object.
invokeMethod(Class, String, Class[], Object[]) - Static method in class org.ktc.rbutils.api.reflect.ReflectUtils
Invokes a static method of a given class with given arguments.
isDirectory(File) - Static method in class org.ktc.rbutils.api.file.ValidateFile
Validate an argument, throwing Exception if the File argument is not a directory.
isFile(File) - Static method in class org.ktc.rbutils.api.file.ValidateFile
Validate an argument, throwing Exception if the File argument does not exist ant is not a file (file as in a file system).
isLoggerTypeValue(String) - Static method in class org.ktc.rbutils.rb.AbstractRbTask.LoggerType
Indicates if the argument is a logger type value.
isLoggerTypeValue(String) - Static method in class org.ktc.rbutils.rb.LoggerType
Indicates if the argument is a logger type value.
isRootParentOfFile(File, File) - Static method in class org.ktc.rbutils.api.file.FileTools
Determines if file is in the root directory.

J

JAVA_EXTENSION - Static variable in class org.ktc.rbutils.api.file.FileTools
The file extension of a java file.

L

load(File) - Method in class org.ktc.rbutils.api.i18n.PropertiesRB
Reads a property list (key and element pairs) from a file.
loadBundle() - Method in class org.ktc.rbutils.rb.check.FileChecker
Loads the ResourceBundle relying on the properties file and stores it in the rbfile field.
locale - Variable in class org.ktc.rbutils.api.audit.event.FileEvent
The Locale of the File on which this Event occurs.
LOCALE_SEPARATOR - Static variable in class org.ktc.rbutils.api.i18n.LocaleUtils
The Locale separator as String.
LOCALE_SEPARATOR_CHAR - Static variable in class org.ktc.rbutils.api.i18n.LocaleUtils
The Locale separator character.
LocaleUtils - Class in org.ktc.rbutils.api.i18n
General Locale manipulation utilities.
LocaleUtils() - Constructor for class org.ktc.rbutils.api.i18n.LocaleUtils
Dummy constructor.
Localized - Interface in org.ktc.rbutils.api.i18n
Base Interface for all classes with Message capability.
Logger - Interface in org.ktc.rbutils.api.audit
Logger in charge of receiving events from the Processor.
LoggerCreator - Class in org.ktc.rbutils.rb
Utility class that helps for logger creation.
LoggerCreator() - Constructor for class org.ktc.rbutils.rb.LoggerCreator
Instanciates a new Logger.
LoggerHelper - Class in org.ktc.rbutils.api.audit
An helper implementation of the Logger interface.
LoggerHelper() - Constructor for class org.ktc.rbutils.api.audit.LoggerHelper
Constructs a new instance of LoggerHelper.
loggers - Variable in class org.ktc.rbutils.api.audit.AbstractProcessor
List of registered loggers in this Processor.
LoggerType - Class in org.ktc.rbutils.rb
Enumerated attribute for RbUtils logger type.
logTaskStarts() - Method in class org.ktc.rbutils.rb.AbstractRbTask
Display, via the ant loggers, that the task starts.

M

main(String[]) - Static method in class org.ktc.rbutils.rb.check.RbCheckerCli
Launches the check of source files found in a directory.
main(String[]) - Static method in class org.ktc.rbutils.rb.content.RbContentListerUtility
Lists the content of a ResourceBundle.
main(String[]) - Static method in class org.ktc.rbutils.rb.generation.RbGeneratorCli
Launches the generation of java ResourceBundle from source files found in a directory.
MainChecker - Class in org.ktc.rbutils.rb.check
Checks a set of Java RessourceBundle files using a set of Properties files.
MainChecker(File) - Constructor for class org.ktc.rbutils.rb.check.MainChecker
Constructs a checker with recursive check in directories and default valid extension for properties files.
MainChecker(File, String) - Constructor for class org.ktc.rbutils.rb.check.MainChecker
Constructs a checker with recursive check in directories.
MainGenerator - Class in org.ktc.rbutils.rb.generation
Generates a set of Java RessourceBundle source files using a set of Properties files.
MainGenerator(File, File) - Constructor for class org.ktc.rbutils.rb.generation.MainGenerator
Instanciates a new MainGenerator.
mainNoExit(String[], PrintWriter) - Static method in class org.ktc.rbutils.rb.check.RbCheckerUtility
Launches the utility.
mainNoExit(String[], PrintWriter) - Static method in class org.ktc.rbutils.rb.content.RbContentListerUtility
Launches the utility.
mainNoExit(String[], PrintWriter) - Static method in class org.ktc.rbutils.rb.generation.RbGeneratorUtility
Launches the utility.
MainProcessor - Interface in org.ktc.rbutils.api.audit
Base interface for Main Processing.
maxErrors - Variable in class org.ktc.rbutils.rb.AbstractRbTask
The maximum number of errors that are tolerated before breaking the build or setting the failure property.
message - Variable in class org.ktc.rbutils.api.audit.event.ProcessEvent
Message contained by this Event.
Message - Class in org.ktc.rbutils.api.i18n
Represents a message that can be localised.
Message(String, String, Object[]) - Constructor for class org.ktc.rbutils.api.i18n.Message
Creates a new Message instance.
messagetype - Variable in class org.ktc.rbutils.api.audit.event.ProcessEvent
Type of Message that defined this Event.
MessageType - Class in org.ktc.rbutils.api.audit
MessageType are used to let the user know the message origin: Information, Errors or Exception.
MSG_MISSING_REQUIRED_OPTION - Static variable in class org.ktc.rbutils.rb.AbstractUtility
Displayed message for user (to be used by subclasses when error occurs on parameter parsing).

N

normalizeNoEndSeparator(File) - Static method in class org.ktc.rbutils.api.file.FileTools
Normalizes the absolute path of a File with the {org.apache.commons.io.FilenameUtils#normalizeNoEndSeparator(java.lang.String) normalizeNoEndSeparator()} method.
NotDirectoryException - Exception in org.ktc.rbutils.api.file
Exception thrown when a File is not a directory in the filesystem.
NotDirectoryException(File) - Constructor for exception org.ktc.rbutils.api.file.NotDirectoryException
Instanciates a new NotDirectoryException.
NotFileException - Exception in org.ktc.rbutils.api.file
Exception thrown when a File is not a file in the filesystem.
NotFileException(File) - Constructor for exception org.ktc.rbutils.api.file.NotFileException
Instanciates a new NotFileException.
notNull(File) - Static method in class org.ktc.rbutils.api.file.ValidateFile
Validate an argument, throwing NullArgumentException if the File is null.
NotRootParentOfFileException - Exception in org.ktc.rbutils.api.file
Exception thrown when a File is not parent of another one.
NotRootParentOfFileException(File, File) - Constructor for exception org.ktc.rbutils.api.file.NotRootParentOfFileException
Instanciates a new NotRootParentOfFileException.

O

OPTION_EXTENSION - Static variable in class org.ktc.rbutils.rb.AbstractUtility
The e option (for properties files extension).
OPTION_FC - Static variable in class org.ktc.rbutils.rb.check.RbCheckerUtility
The fc option (for filechecker class name).
OPTION_FILE - Static variable in class org.ktc.rbutils.rb.AbstractUtility
The f option (for files to be processed).
OPTION_GEN - Static variable in class org.ktc.rbutils.rb.generation.RbGeneratorUtility
The g option (for target generation directory).
OPTION_LOG - Static variable in class org.ktc.rbutils.rb.AbstractUtility
The l option (for loggers to be registered).
OPTION_ROOT - Static variable in class org.ktc.rbutils.rb.AbstractUtility
The r option (for root directory).
options - Variable in class org.ktc.rbutils.rb.AbstractUtility
Options of this utility.
org.ktc.rbutils - package org.ktc.rbutils
 
org.ktc.rbutils.api - package org.ktc.rbutils.api
 
org.ktc.rbutils.api.audit - package org.ktc.rbutils.api.audit
 
org.ktc.rbutils.api.audit.event - package org.ktc.rbutils.api.audit.event
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. ##### ##### TYPE YOUR PACKAGE COMMENTS HERE.
org.ktc.rbutils.api.file - package org.ktc.rbutils.api.file
 
org.ktc.rbutils.api.i18n - package org.ktc.rbutils.api.i18n
 
org.ktc.rbutils.api.reflect - package org.ktc.rbutils.api.reflect
 
org.ktc.rbutils.rb - package org.ktc.rbutils.rb
 
org.ktc.rbutils.rb.check - package org.ktc.rbutils.rb.check
 
org.ktc.rbutils.rb.content - package org.ktc.rbutils.rb.content
Gives the content of a ResourceBundle
org.ktc.rbutils.rb.generation - package org.ktc.rbutils.rb.generation
 

P

PACKAGE_SEPARATOR - Static variable in class org.ktc.rbutils.api.file.FileTools
The package separator String.
PACKAGE_SEPARATOR_CHAR - Static variable in class org.ktc.rbutils.api.file.FileTools
The package separator character.
parse(Exception, PrintWriter) - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses an Exception and provides a user readable messages which is printed in the PrintWriter.
parse(Exception, PrintWriter) - Method in interface org.ktc.rbutils.rb.Utility
Parses an Exception and provides a user readable messages which is printed in the PrintWriter.
parseParameters() - Method in class org.ktc.rbutils.rb.AbstractUtility
Parses the internalArgs field according to the options field.
parseParameters() - Method in class org.ktc.rbutils.rb.content.RbContentListerUtility
Parses the internalArgs field according to the options field.
parseParameters() - Method in interface org.ktc.rbutils.rb.Utility
Parses the internalArgs field according to the options field.
performCheck() - Method in class org.ktc.rbutils.rb.check.FileChecker
Performs the check of properties file.
performGeneration() - Method in class org.ktc.rbutils.rb.generation.FileGenerator
Performs the generation of the Java File.
PLAIN - Static variable in class org.ktc.rbutils.rb.LoggerType
Enum value for a plain logger.
PLAIN_STRING - Static variable in class org.ktc.rbutils.rb.LoggerType
String value for a plain logger.
process() - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Processes the underlying action of this MainProcessor.
process() - Method in class org.ktc.rbutils.rb.check.MainChecker
Launches the check of the properties source files against the runtime files (properties or class files).
process() - Method in class org.ktc.rbutils.rb.check.RbCheckerUtility
Launches the utility.
process() - Method in class org.ktc.rbutils.rb.content.RbContentListerUtility
Launches the utility.
process() - Method in class org.ktc.rbutils.rb.generation.MainGenerator
Generates a Java RessourceBundle source class in the genRootdir directory for each file found in the propsRootDir directory.
process() - Method in class org.ktc.rbutils.rb.generation.RbGeneratorUtility
Launches the utility.
processEnded(ProcessEndEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Logs a process end event.
processEnded(ProcessEndEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs a process end event.
processEnded(ProcessEndEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process end event.
processEnded(ProcessEndEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process end event.
ProcessEndEvent - Class in org.ktc.rbutils.api.audit.event
Event that occurs at the end of an audit.
ProcessEndEvent(Object, File) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessEndEvent
Constructs a RootEvent.
ProcessEvent - Class in org.ktc.rbutils.api.audit.event
Event that occur during the process of an audit in the RbUtils project.
ProcessEvent(Object) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessEvent
Constructs a ProcessEvent.
ProcessEvent(Object, MessageType, Message, String) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessEvent
Constructs a ProcessEvent.
processFileEnded(ProcessFileEndEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Logs a process end event on a specific file.
processFileEnded(ProcessFileEndEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs a process end event on a specific file.
processFileEnded(ProcessFileEndEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process end event on a specific file.
processFileEnded(ProcessFileEndEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process end event on a specific file.
ProcessFileEndEvent - Class in org.ktc.rbutils.api.audit.event
Event that occurs at the end of a File audit.
ProcessFileEndEvent(Object, String, Locale, String) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessFileEndEvent
Constructs an Event that occurs at the end of a File audit.
processFileStarted(ProcessFileStartEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Logs a process start event on a specific file.
processFileStarted(ProcessFileStartEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs a process start event on a specific file.
processFileStarted(ProcessFileStartEvent) - Method in class org.ktc.rbutils.api.audit.FileCounter
Logs a process start event on a specific file.
processFileStarted(ProcessFileStartEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process start event on a specific file.
processFileStarted(ProcessFileStartEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process start event on a specific file.
ProcessFileStartEvent - Class in org.ktc.rbutils.api.audit.event
Event that occurs at the beginning of a File audit.
ProcessFileStartEvent(Object, String, Locale, String) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessFileStartEvent
Constructs an Event that occurs at the beginning of a File audit.
Processor - Interface in org.ktc.rbutils.api.audit
Base interface of the process system.
processor - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Processor used by the task to do the job.
processStarted(ProcessStartEvent) - Method in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Logs a process start event.
processStarted(ProcessStartEvent) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Logs a process start event.
processStarted(ProcessStartEvent) - Method in class org.ktc.rbutils.api.audit.EventCounter
Logs a process start event.
processStarted(ProcessStartEvent) - Method in interface org.ktc.rbutils.api.audit.Logger
Logs a process start event.
processStarted(ProcessStartEvent) - Method in class org.ktc.rbutils.api.audit.LoggerHelper
Logs a process start event.
ProcessStartEvent - Class in org.ktc.rbutils.api.audit.event
Event that occurs at the end of an audit.
ProcessStartEvent(Object, File) - Constructor for class org.ktc.rbutils.api.audit.event.ProcessStartEvent
Constructs a RootEvent.
PropertiesRB - Class in org.ktc.rbutils.api.i18n
Adds locale feature to the Properties class.
PropertiesRB() - Constructor for class org.ktc.rbutils.api.i18n.PropertiesRB
Calls the super constructor and sets the locale of the current object with the empty locale.
PropertiesRB(Properties) - Constructor for class org.ktc.rbutils.api.i18n.PropertiesRB
Calls the super constructor and sets the locale of the current object with the empty locale.
propertiesRB - Variable in class org.ktc.rbutils.rb.check.FileChecker
The properties source file.

Q

QUIET - Static variable in class org.ktc.rbutils.rb.LoggerType
Enum value for a quiet logger.
QUIET_STRING - Static variable in class org.ktc.rbutils.rb.LoggerType
String value for a quiet logger.

R

RBCHECKER - Static variable in class org.ktc.rbutils.rb.TaskType
Name of the rbchecker task to be displayed.
RBCHECKER_TASKNAME - Static variable in class org.ktc.rbutils.rb.CommonProps
Name of the rbchecker task to be displayed.
RbCheckerCli - Class in org.ktc.rbutils.rb.check
Command line utility to be called for ResourceBundle check (see project documentation for cli options).
RbCheckerTask - Class in org.ktc.rbutils.rb.check
The ant task for RB Check.
RbCheckerTask() - Constructor for class org.ktc.rbutils.rb.check.RbCheckerTask
Instanciates a new RbCheckerTask.
RbCheckerUtility - Class in org.ktc.rbutils.rb.check
Command line utility for ResourceBundle check.
RbCheckerUtility(String[]) - Constructor for class org.ktc.rbutils.rb.check.RbCheckerUtility
Creates a new instance of RbCheckerUtility.
RBCONTENTLISTER - Static variable in class org.ktc.rbutils.rb.TaskType
Name of the rbcontentlister task to be displayed.
RbContentListerUtility - Class in org.ktc.rbutils.rb.content
Command line utility for ResourceBundle Content List.
RbContentListerUtility(String[], PrintWriter) - Constructor for class org.ktc.rbutils.rb.content.RbContentListerUtility
Creates a new instance of ContentListerUtility.
RbEvent - Class in org.ktc.rbutils.api.audit.event
Base event for the RbUtils project.
RbEvent(Object) - Constructor for class org.ktc.rbutils.api.audit.event.RbEvent
Constructs a prototypical RbEvent.
rbFile - Variable in class org.ktc.rbutils.rb.check.FileChecker
The RB class file to be inspected.
RBGENERATOR - Static variable in class org.ktc.rbutils.rb.TaskType
Name of the rbgenerator task to be displayed.
RBGENERATOR_TASKNAME - Static variable in class org.ktc.rbutils.rb.CommonProps
Name of the rbgenerator task to be displayed.
RbGeneratorCli - Class in org.ktc.rbutils.rb.generation
Command line utility to be called for ResourceBundle generation (see project documentation for cli options).
RbGeneratorTask - Class in org.ktc.rbutils.rb.generation
The ant task for RB Generation.
RbGeneratorTask() - Constructor for class org.ktc.rbutils.rb.generation.RbGeneratorTask
Instanciates a new RbGeneratorTask.
RbGeneratorUtility - Class in org.ktc.rbutils.rb.generation
Command line utility for ResourceBundle generation.
RbGeneratorUtility(String[]) - Constructor for class org.ktc.rbutils.rb.generation.RbGeneratorUtility
Creates a new instance of RbGeneratorUtility.
rbKeys - Variable in class org.ktc.rbutils.rb.check.FileChecker
List of keys in the resourcebundle.
RbUtilsException - Exception in org.ktc.rbutils.api
Represents an error condition within RbUtils.
RbUtilsException(String) - Constructor for exception org.ktc.rbutils.api.RbUtilsException
Creates a new CheckstyleException instance.
RbUtilsHelper - Class in org.ktc.rbutils
Provides general informations about the RbUtils project.
RbUtilsHelper() - Constructor for class org.ktc.rbutils.RbUtilsHelper
Dummy constructor.
RbUtilsRuntimeException - Exception in org.ktc.rbutils.api
Represents a runtime error condition within RbUtils.
RbUtilsRuntimeException(String) - Constructor for exception org.ktc.rbutils.api.RbUtilsRuntimeException
Creates a new RbUtilsRuntimeException instance.
recursiveCheck - Variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
true if the check must be performed on all subdirectories of the root directory.
ReflectUtils - Class in org.ktc.rbutils.api.reflect
Provides reflection utilities.
ReflectUtils() - Constructor for class org.ktc.rbutils.api.reflect.ReflectUtils
Does Nothing.
removeLocale(String) - Static method in class org.ktc.rbutils.api.i18n.LocaleUtils
Removes the locale part in a String.
REQUIRED_HEADER - Static variable in class org.ktc.rbutils.rb.AbstractUtility
Header for required field used when the usage of the utility is displayed.
root - Variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Root directory of the files processed by this Processor.
root - Variable in class org.ktc.rbutils.rb.AbstractRbTask
Root directory used to find properties file.
root - Variable in class org.ktc.rbutils.rb.AbstractUtility
The root directory to be used by this utility.
rootDirectory - Variable in class org.ktc.rbutils.api.audit.event.RootEvent
The root directory on which this event applies.
RootEvent - Class in org.ktc.rbutils.api.audit.event
Base event for main events which occur on a root directory.
RootEvent(Object, File) - Constructor for class org.ktc.rbutils.api.audit.event.RootEvent
Constructs a RootEvent.

S

SEP_LOG_OPTION - Static variable in class org.ktc.rbutils.rb.AbstractUtility
Separator used to separate logger type and logging file.
setDisplayLocale(String) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Sets the locale to be used to generate message used on logging.
setExtension(String) - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Sets the extension that will be used in order to find properties files in the root directory.
setExtension(String) - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Sets the extension that will be used in order to find properties files in the root directory.
setExtension(String) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Sets the extension of the properties file used for the check.
setFailOnErrors(boolean) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Tells this task whether to fail if errors occur during the check.
setFailureProperty(String) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Tells this task to set the named property to "true" when there is a violation.
setFilechecker(String) - Method in class org.ktc.rbutils.rb.check.RbCheckerTask
Class name of the FileChecker to be used by the MainChecker.
setFileCheckerClassname(String) - Method in class org.ktc.rbutils.rb.check.MainChecker
Sets the name of the class to be used as FileChecker.
setFilesAlreadyAdded(boolean) - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Indicates that files have already been added to the file list to be inspected.
setFilesAlreadyAdded(boolean) - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Indicates that files have already been added to the file list to be inspected.
setGenRootdir(File) - Method in class org.ktc.rbutils.rb.generation.RbGeneratorTask
Sets the directory where the java file will be generated.
setLocale(Locale) - Static method in class org.ktc.rbutils.api.i18n.Message
Sets the locale to use for localization.
setLoggerType(LoggerType) - Method in class org.ktc.rbutils.rb.LoggerCreator
Set the type of the logger.
setLoggerType(String) - Method in class org.ktc.rbutils.rb.LoggerCreator
Sets the type of logger.
setMaxErrors(int) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Sets the maximum number of errors allowed.
setMessagesLocale(Locale) - Method in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Sets the locale used to display the messages during this process.
setMessagesLocale(Locale) - Method in interface org.ktc.rbutils.api.audit.MainProcessor
Sets the locale used to display the messages during this process.
setOutputFile(File) - Method in class org.ktc.rbutils.rb.AbstractRbTask.Log
Set the file to output to.
setOutputFile(File) - Method in class org.ktc.rbutils.rb.LoggerCreator
Set the file to output to.
setOutputFile(String) - Method in class org.ktc.rbutils.rb.LoggerCreator
Set the file to output to.
setOutputStream(OutputStream) - Method in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Sets the OutputStream.
setRoot(File) - Method in class org.ktc.rbutils.rb.AbstractRbTask
Sets the directory where the properties files will be searched for the check.
setType(AbstractRbTask.LoggerType) - Method in class org.ktc.rbutils.rb.AbstractRbTask.Log
Set the type of the logger.
specificTaskinitilization() - Method in class org.ktc.rbutils.rb.AbstractRbTask
Adds specific Initialization to the task.
specificTaskinitilization() - Method in class org.ktc.rbutils.rb.check.RbCheckerTask
Adds specific Initialization to the task. Sets the filechecker class name.
specificTaskinitilization() - Method in class org.ktc.rbutils.rb.generation.RbGeneratorTask
Adds specific Initialization to the task.
srcRBextension - Variable in class org.ktc.rbutils.api.audit.AbstractMainProcessor
Extension of the properties file used as source for the check.
StringTools - Class in org.ktc.rbutils.api
Provides String utilities for escaping characters.
StringTools() - Constructor for class org.ktc.rbutils.api.StringTools
Dummy constructor.

T

TAB - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Represents a tabulation character; 4 spaces.
TAB - Static variable in class org.ktc.rbutils.rb.generation.FileGenerator
String used for tabulation representation on code generation.
tab(int) - Static method in class org.ktc.rbutils.rb.generation.FileGenerator
Returns a String which contains the number of tabulations specified as argument.
TAB_2 - Static variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Represents two tabulation characters; 8 spaces.
taskname - Variable in class org.ktc.rbutils.api.audit.AbstractDefaultLogger
Name of the task that manages the process.
taskName - Variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Name of the task that this logger is inspecting.
taskName - Variable in class org.ktc.rbutils.rb.AbstractUtility
Name of the RbUtils task of this utility.
taskType - Variable in class org.ktc.rbutils.rb.AbstractRbTask
The type of the Task.
TaskType - Class in org.ktc.rbutils.rb
Enumeration of the task supported by RbUtils.
toLocale(String) - Static method in class org.ktc.rbutils.api.i18n.LocaleUtils
Returns the Locale represented by a String.

U

UNIX_SEPARATOR - Static variable in class org.ktc.rbutils.api.file.FileTools
The Unix file separator String.
UNIX_SEPARATOR_CHAR - Static variable in class org.ktc.rbutils.api.file.FileTools
The Unix file separator character.
UNKNONWN - Static variable in class org.ktc.rbutils.rb.TaskType
Name of an unknown rbutils task to be displayed.
UNKNONWN_TASKNAME - Static variable in class org.ktc.rbutils.rb.CommonProps
Name of an unknown rbutils task to be displayed.
UnknownTaskException - Exception in org.ktc.rbutils.api
Thrown when a specified Task Name does not correpond to a RbUtils task.
UnknownTaskException(String) - Constructor for exception org.ktc.rbutils.api.UnknownTaskException
Creates a new UnknownTaskException instance.
UnSpecifiedFileException - Exception in org.ktc.rbutils.api
Thrown when a object requires a File and the File is not provided.
UnSpecifiedFileException(String) - Constructor for exception org.ktc.rbutils.api.UnSpecifiedFileException
Creates a new UnSpecifiedFileException instance.
usage() - Method in class org.ktc.rbutils.rb.AbstractUtility
Prints the usage information of this utility in the Standard Output.
usage(PrintWriter) - Method in class org.ktc.rbutils.rb.AbstractUtility
Prints the usage information of this utility.
usage() - Method in interface org.ktc.rbutils.rb.Utility
Prints the usage information of this utility in the Standard Output.
usage(PrintWriter) - Method in interface org.ktc.rbutils.rb.Utility
Prints the usage information of this utility.
Utility - Interface in org.ktc.rbutils.rb
Base interface for RbUtils command line utilities.

V

ValidateFile - Class in org.ktc.rbutils.api.file
Assists in validating File arguments.
ValidateFile() - Constructor for class org.ktc.rbutils.api.file.ValidateFile
Dummy constructor.
validateFileChecker() - Method in class org.ktc.rbutils.rb.check.MainChecker
Validates the FileChecker.

W

writer - Variable in class org.ktc.rbutils.api.audit.AbstractXmlLogger
Helper writer that allows easy encoding and printing.

X

XML - Static variable in class org.ktc.rbutils.rb.LoggerType
Enum value for an xml logger.
XML_STRING - Static variable in class org.ktc.rbutils.rb.LoggerType
String value for an xml logger.
XmlLogger - Class in org.ktc.rbutils.rb.check
Simple XML logger for rb check process.
XmlLogger(File) - Constructor for class org.ktc.rbutils.rb.check.XmlLogger
Creates a new XmlLogger instance.
XmlLogger - Class in org.ktc.rbutils.rb.generation
Simple XML logger for generation process.
XmlLogger(File) - Constructor for class org.ktc.rbutils.rb.generation.XmlLogger
Creates a new XmlLogger instance.

A B C D E F G H I J L M N O P Q R S T U V W X
Back to the RbUtils Home Page

Copyright © 2005-2009 RbUtils Project. All Rights Reserved.