org.apache.tools.ant

Class Main

public class Main extends Object implements AntMain

Command line entry point into Ant. This class is entered via the canonical `public static void main` entry point and reads the command line arguments. It then assembles and executes an Ant project.

If you integrating Ant into some other tool, this is not the class to use as an entry point. Please see the source code of this class to see how it manipulates the Ant project classes.

Field Summary
static StringDEFAULT_BUILD_FILENAME
The default build file name.
Constructor Summary
Main()
Constructor used when creating Main for later arg processing and startup
protected Main(String[] args)
Sole constructor, which parses and deals with command line arguments.
Method Summary
protected voidaddBuildListeners(Project project)
Adds the listeners specified in the command line arguments, along with the default listener, to the specified project.
static StringgetAntVersion()
Returns the Ant version information, if available.
static voidmain(String[] args)
Command line entry point.
static voidstart(String[] args, Properties additionalUserProperties, ClassLoader coreLoader)
Creates a new instance of this class using the arguments specified, gives it any extra user properties which have been specified, and then runs the build using the classloader provided.
voidstartAnt(String[] args, Properties additionalUserProperties, ClassLoader coreLoader)
Start Ant

Field Detail

DEFAULT_BUILD_FILENAME

public static final String DEFAULT_BUILD_FILENAME
The default build file name.

Constructor Detail

Main

public Main()
Constructor used when creating Main for later arg processing and startup

Main

protected Main(String[] args)

Deprecated:

Sole constructor, which parses and deals with command line arguments.

Parameters: args Command line arguments. Must not be null.

Throws: BuildException if the specified build file doesn't exist or is a directory.

Method Detail

addBuildListeners

protected void addBuildListeners(Project project)
Adds the listeners specified in the command line arguments, along with the default listener, to the specified project.

Parameters: project The project to add listeners to. Must not be null.

getAntVersion

public static String getAntVersion()
Returns the Ant version information, if available. Once the information has been loaded once, it's cached and returned from the cache on future calls.

Returns: the Ant version information as a String (always non-null)

Throws: BuildException if the version information is unavailable

main

public static void main(String[] args)
Command line entry point. This method kicks off the building of a project object and executes a build using either a given target or the default target.

Parameters: args Command line arguments. Must not be null.

start

public static void start(String[] args, Properties additionalUserProperties, ClassLoader coreLoader)
Creates a new instance of this class using the arguments specified, gives it any extra user properties which have been specified, and then runs the build using the classloader provided.

Parameters: args Command line arguments. Must not be null. additionalUserProperties Any extra properties to use in this build. May be null, which is the equivalent to passing in an empty set of properties. coreLoader Classloader used for core classes. May be null in which case the system classloader is used.

startAnt

public void startAnt(String[] args, Properties additionalUserProperties, ClassLoader coreLoader)
Start Ant

Parameters: args command line args additionalUserProperties properties to set beyond those that may be specified on the args list coreLoader - not used

Since: Ant 1.6

Copyright