|
RbUtils 0.13 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Utility
Base interface for RbUtils command line utilities.
Method Summary | |
---|---|
String |
getExtension()
Parses the arguments of this utility in order to get the extension of properties files to be used by this utility. |
List |
getFilesToBeProcessed()
Returns a list of properties files to be processed (-f option). |
Collection |
getLoggers()
Parses the arguments of this utility in order to get the loggers to be used by this utility. |
File |
getRootDir()
Parses the arguments of this utility in order to get the root directory to be used by this utility. |
void |
parse(Exception exception,
PrintWriter pw)
Parses an Exception and provides a user readable messages which is printed in the PrintWriter. |
void |
parseParameters()
Parses the internalArgs field according to the options field. |
void |
usage()
Prints the usage information of this utility in the Standard Output. |
void |
usage(PrintWriter pw)
Prints the usage information of this utility. |
Method Detail |
---|
void parseParameters() throws ParseException
internalArgs
field according to the options
field.
ParseException
- if an error occurs during parsing.File getRootDir() throws RbUtilsException, FileNotFoundException
The parseParameters()
method MUST have been previously called.
RbUtilsException
- if more than one -r option is specified.
FileNotFoundException
- if the -r option specifies a directory that does not exist in
the file system.
NotDirectoryException
- if the -r value specifies a file in
the file system instead of a directory.List getFilesToBeProcessed() throws FileNotFoundException
NOTE: The parseParameters() and getRootDir() methods must have been called before the call of this method.
FileNotFoundException
- if a provided file does not exist in the file system.
NotFileException
- if the -r value specifies a directory in
the file system instead of a file.Collection getLoggers() throws UnSpecifiedFileException, IOException
UnSpecifiedFileException
- if a Logger to be created requires a logging file and
loggingFile is null
IOException
- if an error occurs on file logger initialization.String getExtension() throws RbUtilsException
The parseParameters()
method MUST have been previously called.
RbUtilsException
- if more than one -e option is specified.void usage()
void usage(PrintWriter pw)
pw
- the Writer where the information will be print.void parse(Exception exception, PrintWriter pw)
The Writer is not closed by this method.
exception
- the Exception to be parsed.pw
- the Writer where the message is printed.
|
Back to the RbUtils Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |