java4unix

Class CommandLineApplication

java.lang.Object

java4unix.Application

java4unix.CommandLineApplication

Direct Known Subclasses:

J4UScript

public abstract class CommandLineApplication
extends Application

Constructor Summary

Constructors

Constructor and Description
CommandLineApplication(toools.io.file.RegularFile launcher)

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String longName, java.lang.String shortName, java.lang.String regex, java.lang.String defaultValue, java.lang.String description)
protected void	cancelLastPrint()
static java.lang.String	computeFileName(java.lang.String appName, java.lang.Class<? extends CommandLineApplication> c)
void	createLauncher()
protected abstract void	declareArguments(java.util.Collection<ArgumentSpecification> argumentSpecifications)
protected abstract void	declareOptions(java.util.Collection<OptionSpecification> optionSpecifications)
void	ensureMandatoryStuffAreSpecified(CommandLine cmdLine)
protected toools.config.Configuration	extractConfiguration()
toools.io.file.RegularFile	findFile(java.lang.String name)
toools.io.file.RegularFile	getActualConfigurationFile()
CommandLineSpecification	getCommandLineSpecification()
toools.io.file.Directory	getDataDirectory()
protected toools.io.file.RegularFile	getDataFile(java.lang.String filename)
toools.io.file.RegularFile	getDefaultConfigurationFile()
java.lang.String	getHelp(boolean printUtilityOptions)
toools.io.file.Directory	getHomeDirectory()
toools.io.file.Directory	getInstallationDirectory()
toools.io.file.Directory	getJarsDirectory()
java.lang.String	getLastPrint()
java.lang.String	getLauncherCode()
java.lang.String	getName() Computes the name of the script out of the name of the class For example, "lucci.cmdline.MyScript" becomes "MyScript".
protected java.lang.String	getOptionValue(CommandLine cmdLine, java.lang.String optionName)
java.lang.String	getUsage()
toools.io.file.RegularFile	getUserConfigurationFile()
toools.io.file.RegularFile	getUserFile(java.lang.String filename)
double	getVerbosity()
protected java.lang.String	getVMOptionsAsText()
boolean	isInteractive()
protected boolean	isOptionSpecified(CommandLine cmdLine, java.lang.String optionName)
protected void	printDebugMessage(java.lang.Object... msg)
protected void	printExceptionStrackTrace(java.lang.Exception e)
protected void	printFatalError(java.lang.Object... msg)
protected void	printMessage(java.lang.Object... msg)
protected void	printMessage(java.io.PrintStream os, java.lang.Object msg)
protected void	printMessage(java.io.PrintStream os, java.lang.Object msg, double importance, boolean addnewline)
protected void	printMessageWithNoNewLine(java.lang.Object msg)
protected void	printNonFatalError(java.lang.Object... msg)
protected void	printWarning(java.lang.Object... msg)
protected java.lang.String	readUserInput(java.lang.String invitation, java.lang.String regexp)
int	run(java.util.List<java.lang.String> args)
int	run(java.lang.String... args)
abstract int	runScript(CommandLine cmdLine)
void	saveConfiguration(java.lang.String key, java.lang.String value)
int	select(java.util.List<java.lang.String> list)
void	setInteractive(boolean interactive)
void	setVerbosity(double verbosity)

Methods inherited from class java4unix.Application

getApplicationName, getAuthor, getClasspathEntry, getLicence, getShortDescription, getVersion, getVMOptions, getYear

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineApplication

public CommandLineApplication(toools.io.file.RegularFile launcher)

Method Detail

getInstallationDirectory

public toools.io.file.Directory getInstallationDirectory()

addOption

public void addOption(java.lang.String longName,
                      java.lang.String shortName,
                      java.lang.String regex,
                      java.lang.String defaultValue,
                      java.lang.String description)

getUsage

public final java.lang.String getUsage()

isOptionSpecified

protected final boolean isOptionSpecified(CommandLine cmdLine,
                                          java.lang.String optionName)

getOptionValue

protected final java.lang.String getOptionValue(CommandLine cmdLine,
                                                java.lang.String optionName)

getName

public final java.lang.String getName()

Computes the name of the script out of the name of the class For example, "lucci.cmdline.MyScript" becomes "MyScript".

Returns:

computeFileName

public static java.lang.String computeFileName(java.lang.String appName,
                                               java.lang.Class<? extends CommandLineApplication> c)

getHelp

public final java.lang.String getHelp(boolean printUtilityOptions)

run

public final int run(java.lang.String... args)
              throws java.lang.Throwable

Throws:

java.lang.Throwable

run

public final int run(java.util.List<java.lang.String> args)
              throws java.lang.Throwable

Throws:

java.lang.Throwable

declareOptions

protected abstract void declareOptions(java.util.Collection<OptionSpecification> optionSpecifications)

declareArguments

protected abstract void declareArguments(java.util.Collection<ArgumentSpecification> argumentSpecifications)

getJarsDirectory

public final toools.io.file.Directory getJarsDirectory()

createLauncher

public final void createLauncher()
                          throws java.io.IOException

Throws:

java.io.IOException

getLauncherCode

public java.lang.String getLauncherCode()

getVMOptionsAsText

protected final java.lang.String getVMOptionsAsText()

runScript

public abstract int runScript(CommandLine cmdLine)
                       throws java.lang.Throwable

Throws:

java.lang.Throwable

getCommandLineSpecification

public CommandLineSpecification getCommandLineSpecification()

ensureMandatoryStuffAreSpecified

public final void ensureMandatoryStuffAreSpecified(CommandLine cmdLine)
                                            throws InvalidOptionValueException

Throws:

InvalidOptionValueException

printMessage

protected void printMessage(java.io.PrintStream os,
                            java.lang.Object msg,
                            double importance,
                            boolean addnewline)

cancelLastPrint

protected void cancelLastPrint()

printMessageWithNoNewLine

protected final void printMessageWithNoNewLine(java.lang.Object msg)

printMessage

protected final void printMessage(java.io.PrintStream os,
                                  java.lang.Object msg)

printMessage

protected final void printMessage(java.lang.Object... msg)

printWarning

protected final void printWarning(java.lang.Object... msg)

printDebugMessage

protected final void printDebugMessage(java.lang.Object... msg)

printNonFatalError

protected final void printNonFatalError(java.lang.Object... msg)

printFatalError

protected final void printFatalError(java.lang.Object... msg)

printExceptionStrackTrace

protected final void printExceptionStrackTrace(java.lang.Exception e)

readUserInput

protected final java.lang.String readUserInput(java.lang.String invitation,
                                               java.lang.String regexp)

getVerbosity

public final double getVerbosity()

setVerbosity

public final void setVerbosity(double verbosity)

getHomeDirectory

public final toools.io.file.Directory getHomeDirectory()

select

public final int select(java.util.List<java.lang.String> list)

getDataDirectory

public final toools.io.file.Directory getDataDirectory()

getDefaultConfigurationFile

public final toools.io.file.RegularFile getDefaultConfigurationFile()

getUserConfigurationFile

public final toools.io.file.RegularFile getUserConfigurationFile()

getUserFile

public toools.io.file.RegularFile getUserFile(java.lang.String filename)

getActualConfigurationFile

public final toools.io.file.RegularFile getActualConfigurationFile()

findFile

public toools.io.file.RegularFile findFile(java.lang.String name)

getLastPrint

public java.lang.String getLastPrint()

extractConfiguration

protected toools.config.Configuration extractConfiguration()
                                                    throws java.io.IOException

Throws:

java.io.IOException

saveConfiguration

public void saveConfiguration(java.lang.String key,
                              java.lang.String value)
                       throws java.io.IOException

Throws:

java.io.IOException

isInteractive

public boolean isInteractive()

setInteractive

public void setInteractive(boolean interactive)

getDataFile

protected toools.io.file.RegularFile getDataFile(java.lang.String filename)