Apache Ant Launcher 1.10.14 · org.apache.tools.ant.launch.Launcher

Field Summary

Modifier and Type	Field and Description
public static final String	ANT_PRIVATEDIR The directory name of the per-user ant directory.
public static final String	ANT_PRIVATELIB The name of a per-user library directory.
public static final String	ANTHOME_PROPERTY The Ant Home (installation) Directory property.
public static final String	ANTLIBDIR_PROPERTY The Ant Library Directory property.
protected static final int	EXIT_CODE_ERROR Exit code on trouble
private static final String	JAVA_CLASS_PATH System property with application classpath.
public boolean	launchDiag launch diagnostics flag; for debugging trouble at launch time.
public static final String	MAIN_CLASS The startup class that is to be run.
public static final String	USER_HOMEDIR System property with user home directory.
public static final String	USER_LIBDIR The location of a per-user library directory.

Constructor Summary

Access	Constructor and Description
private	Launcher()

Method Summary

Modifier and Type	Method and Description
private void	addPath(final String the classpath or lib path to add to the libPathULRLs path, final boolean if true and a path is a directory, add the jars in the directory to the path urls getJars, final List<URL> the list of paths to add to libPathURLs) Add a CLASSPATH or -lib to lib path urls.
private URL[]	Returns: a combined array getJarArray(final URL[] the jars specified in -lib command line options libJars, final URL[] the jars in ~/.ant/lib userJars, final URL[] the jars in $ANT_HOME/lib systemJars, final File the tools.jar file toolsJar) Combine the various jar sources into a single array of jars.
private URL[]	Returns: an array of URLs. getLibPathURLs(final String the classpath string cpString, final List<String> the list of -lib entries. libPaths) Get the list of -lib entries and -cp entry into a URL array.
private URL[]	Returns: the URLs getSystemURLs(final File the dir that ant-launcher ran from antLauncherDir) Get the jar files in ANT_HOME/lib.
private URL[]	Returns: the URLS from the user's lib dir getUserURLs() Get the jar files in user.home/.ant/lib
private void	logPath(final String name, final File path)
public static void	main(final String[] commandline arguments args) Entry point for starting command line Ant.
private int	Returns: an exit code. As the normal ant main calls exit when it ends, this is for handling failures at bind-time run(final String[] the command line arguments args) Run the launcher to launch Ant.
private void	setProperty(final String property name name, final String value value) set a system property, optionally log what is going on

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ANT_PRIVATEDIR	back to summary
public static final String ANT_PRIVATEDIR The directory name of the per-user ant directory. .ant

ANT_PRIVATELIB	back to summary
public static final String ANT_PRIVATELIB The name of a per-user library directory. lib

ANTHOME_PROPERTY	back to summary
public static final String ANTHOME_PROPERTY The Ant Home (installation) Directory property. ant.home

ANTLIBDIR_PROPERTY	back to summary
public static final String ANTLIBDIR_PROPERTY The Ant Library Directory property. ant.library.dir

EXIT_CODE_ERROR	back to summary
protected static final int EXIT_CODE_ERROR Exit code on trouble

JAVA_CLASS_PATH	back to summary
private static final String JAVA_CLASS_PATH System property with application classpath. java.class.path

launchDiag	back to summary
public boolean launchDiag launch diagnostics flag; for debugging trouble at launch time.

MAIN_CLASS	back to summary
public static final String MAIN_CLASS The startup class that is to be run. org.apache.tools.ant.Main

USER_HOMEDIR	back to summary
public static final String USER_HOMEDIR System property with user home directory. user.home

USER_LIBDIR back to summary

USER_LIBDIR	back to summary
public static final String USER_LIBDIR The location of a per-user library directory. It's value is the concatenation of `ANT_PRIVATEDIR` with `ANT_PRIVATELIB`, with an appropriate file separator in between. For example, on Unix, it's `.ant/lib`.

public static final String USER_LIBDIR

The location of a per-user library directory.

It's value is the concatenation of ANT_PRIVATEDIR with ANT_PRIVATELIB, with an appropriate file separator in between. For example, on Unix, it's .ant/lib.

Constructor Detail

Launcher	back to summary
private Launcher()

Method Detail

addPath	back to summary
private void addPath(final String path, final boolean getJars, final List<URL> libPathURLs) throws MalformedURLException Add a CLASSPATH or -lib to lib path urls. Only filesystem resources are supported. Parameters path:String the classpath or lib path to add to the libPathULRLs getJars:boolean if true and a path is a directory, add the jars in the directory to the path urls libPathURLs:List<URL> the list of paths to add to Exceptions MalformedURLException: if we can't create a URL

addPath

back to summary

private void addPath(final String path, final boolean getJars, final List<URL> libPathURLs) throws MalformedURLException

Add a CLASSPATH or -lib to lib path urls. Only filesystem resources are supported.

Parameters

path:String: the classpath or lib path to add to the libPathULRLs
getJars:boolean: if true and a path is a directory, add the jars in the directory to the path urls
libPathURLs:List<URL>: the list of paths to add to

Exceptions

MalformedURLException:: if we can't create a URL

getJarArray	back to summary
private URL[] getJarArray(final URL[] libJars, final URL[] userJars, final URL[] systemJars, final File toolsJar) throws MalformedURLException Combine the various jar sources into a single array of jars. Parameters libJars:URL[] the jars specified in -lib command line options userJars:URL[] the jars in ~/.ant/lib systemJars:URL[] the jars in $ANT_HOME/lib toolsJar:File the tools.jar file Returns:URL[] a combined array Exceptions MalformedURLException: if there is a problem.

getJarArray

back to summary

private URL[] getJarArray(final URL[] libJars, final URL[] userJars, final URL[] systemJars, final File toolsJar) throws MalformedURLException

Combine the various jar sources into a single array of jars.

Parameters

libJars:URL[]: the jars specified in -lib command line options
userJars:URL[]: the jars in ~/.ant/lib
systemJars:URL[]: the jars in $ANT_HOME/lib
toolsJar:File: the tools.jar file

Returns:URL[]

a combined array

Exceptions

MalformedURLException:: if there is a problem.

getLibPathURLs	back to summary
private URL[] getLibPathURLs(final String cpString, final List<String> libPaths) throws MalformedURLException Get the list of -lib entries and -cp entry into a URL array. Parameters cpString:String the classpath string libPaths:List<String> the list of -lib entries. Returns:URL[] an array of URLs. Exceptions MalformedURLException: if the URLs cannot be created.

getLibPathURLs

back to summary

private URL[] getLibPathURLs(final String cpString, final List<String> libPaths) throws MalformedURLException

Get the list of -lib entries and -cp entry into a URL array.

Parameters

cpString:String: the classpath string
libPaths:List<String>: the list of -lib entries.

Returns:URL[]

an array of URLs.

Exceptions

MalformedURLException:: if the URLs cannot be created.

getSystemURLs	back to summary
private URL[] getSystemURLs(final File antLauncherDir) throws MalformedURLException Get the jar files in ANT_HOME/lib. determine ant library directory for system jars: use property or default using location of ant-launcher.jar Parameters antLauncherDir:File the dir that ant-launcher ran from Returns:URL[] the URLs Exceptions MalformedURLException: if the URLs cannot be created.

getSystemURLs

back to summary

private URL[] getSystemURLs(final File antLauncherDir) throws MalformedURLException

Get the jar files in ANT_HOME/lib. determine ant library directory for system jars: use property or default using location of ant-launcher.jar

Parameters

antLauncherDir:File: the dir that ant-launcher ran from

Returns:URL[]

the URLs

Exceptions

MalformedURLException:: if the URLs cannot be created.

getUserURLs	back to summary
private URL[] getUserURLs() throws MalformedURLException Get the jar files in user.home/.ant/lib Returns:URL[] the URLS from the user's lib dir Exceptions MalformedURLException: if the URLs cannot be created.

getUserURLs

back to summary

private URL[] getUserURLs() throws MalformedURLException

Get the jar files in user.home/.ant/lib

Returns:URL[]

the URLS from the user's lib dir

Exceptions

MalformedURLException:: if the URLs cannot be created.

logPath	back to summary
private void logPath(final String name, final File path)

main	back to summary
public static void main(final String[] args) Entry point for starting command line Ant. Parameters args:String[] commandline arguments

main

back to summary

public static void main(final String[] args)

Entry point for starting command line Ant.

Parameters

args:String[]: commandline arguments

run	back to summary
private int run(final String[] args) throws LaunchException, MalformedURLException Run the launcher to launch Ant. Parameters args:String[] the command line arguments Returns:int an exit code. As the normal ant main calls exit when it ends, this is for handling failures at bind-time Exceptions LaunchException: for launching problems MalformedURLException: if the URLs required for the classloader cannot be created.

run

back to summary

private int run(final String[] args) throws LaunchException, MalformedURLException

Run the launcher to launch Ant.

Parameters

args:String[]: the command line arguments

Returns:int

an exit code. As the normal ant main calls exit when it ends, this is for handling failures at bind-time

Exceptions

LaunchException:: for launching problems
MalformedURLException:: if the URLs required for the classloader cannot be created.

setProperty	back to summary
private void setProperty(final String name, final String value) set a system property, optionally log what is going on Parameters name:String property name value:String value

setProperty

back to summary

private void setProperty(final String name, final String value)

set a system property, optionally log what is going on

Parameters

name:String: property name
value:String: value

public Class Launcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail