org.eclipse.ant.core
Class AntCorePlugin

java.lang.Object
  |
  +--org.eclipse.core.runtime.Plugin
        |
        +--org.eclipse.ant.core.AntCorePlugin

public class AntCorePlugin

extends Plugin

The plug-in runtime class for the Ant Core plug-in.

Field Summary

static String	CLASS Simple identifier constant (value "class") of a tag that appears in Ant extensions.
static String	ECLIPSE_PROGRESS_MONITOR Key to access the IProgressMonitor reference.
static int	ERROR_LIBRARY_NOT_SPECIFIED Status code indicating an error occurred as a library was not specified
static int	ERROR_MALFORMED_URL Status code indicating an error occurred due to a malformed URL.
static int	ERROR_RUNNING_BUILD Status code indicating an error occurred running a build.
static String	HEADLESS Simple identifier constant (value "headless") of a tag that appears in Ant extensions.
static int	INTERNAL_ERROR Status code indicating an unexpected internal error.
static String	LIBRARY Simple identifier constant (value "library") of a tag that appears in Ant extensions.
static String	NAME Simple identifier constant (value "name") of a tag that appears in Ant extensions.
static String	PI_ANTCORE Unique identifier constant (value "org.eclipse.ant.core") for the Ant Core plug-in.
static String	PT_EXTRA_CLASSPATH Simple identifier constant (value "extraClasspathEntries") for the extra classpath entries extension point.
static String	PT_TASKS Simple identifier constant (value "antTasks") for the Ant tasks extension point.
static String	PT_TYPES Simple identifier constant (value "antTypes") for the Ant types extension point.

Fields inherited from class org.eclipse.core.runtime.Plugin

PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

AntCorePlugin(IPluginDescriptor descriptor)
Constructs an instance of this plug-in runtime class.

Method Summary

protected ClassLoader	getNewClassLoader() Returns a new class loader to use when executing Ant builds.
static AntCorePlugin	getPlugin() Returns this plug-in instance.
AntCorePreferences	getPreferences() Returns an object representing this plug-in's preferences.
static void	log(Throwable t) Logs the specified throwable with this plug-in's log.
protected void	setRunningHeadless() Set this plug-in's preferences for running headless.
void	shutdown() Shuts down this plug-in and discards all plug-in state.

Methods inherited from class org.eclipse.core.runtime.Plugin

find, find, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, startup, toString

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Status code indicating an unexpected internal error.

Since:

2.1

See Also:

Constant Field Values

PI_ANTCORE

public static final String PI_ANTCORE

Unique identifier constant (value "org.eclipse.ant.core") for the Ant Core plug-in.

See Also:

Constant Field Values

PT_TASKS

public static final String PT_TASKS

Simple identifier constant (value "antTasks") for the Ant tasks extension point.

See Also:

Constant Field Values

PT_EXTRA_CLASSPATH

public static final String PT_EXTRA_CLASSPATH

Simple identifier constant (value "extraClasspathEntries") for the extra classpath entries extension point.

See Also:

Constant Field Values

PT_TYPES

public static final String PT_TYPES

Simple identifier constant (value "antTypes") for the Ant types extension point.

See Also:

Constant Field Values

CLASS

public static final String CLASS

Simple identifier constant (value "class") of a tag that appears in Ant extensions.

See Also:

Constant Field Values

NAME

public static final String NAME

Simple identifier constant (value "name") of a tag that appears in Ant extensions.

See Also:

Constant Field Values

LIBRARY

public static final String LIBRARY

Simple identifier constant (value "library") of a tag that appears in Ant extensions.

See Also:

Constant Field Values

HEADLESS

public static final String HEADLESS

Simple identifier constant (value "headless") of a tag that appears in Ant extensions.

Since:

2.1

See Also:

Constant Field Values

ECLIPSE_PROGRESS_MONITOR

public static final String ECLIPSE_PROGRESS_MONITOR

Key to access the IProgressMonitor reference. When a progress monitor is passed to the AntRunner.run(IProgressMonitor) method, the object is available as a reference for the current Ant project.

See Also:

Constant Field Values

ERROR_RUNNING_BUILD

public static final int ERROR_RUNNING_BUILD

Status code indicating an error occurred running a build.

Since:

2.1

See Also:

Constant Field Values

ERROR_MALFORMED_URL

public static final int ERROR_MALFORMED_URL

Status code indicating an error occurred due to a malformed URL.

Since:

2.1

See Also:

Constant Field Values

ERROR_LIBRARY_NOT_SPECIFIED

public static final int ERROR_LIBRARY_NOT_SPECIFIED

Status code indicating an error occurred as a library was not specified

Since:

2.1

See Also:

Constant Field Values

Constructor Detail

AntCorePlugin

public AntCorePlugin(IPluginDescriptor descriptor)

Constructs an instance of this plug-in runtime class.

An instance of this plug-in runtime class is automatically created when the facilities provided by the Ant Core plug-in are required. Clients must never explicitly instantiate a plug-in runtime class.

Method Detail

shutdown

public void shutdown()
              throws CoreException

Description copied from class: Plugin

Shuts down this plug-in and discards all plug-in state.

This method should be re-implemented in subclasses that need to do something when the plug-in is shut down. Implementors should call the inherited method to ensure that any system requirements can be met.

Plug-in shutdown code should be robust. In particular, this method should always make an effort to shut down the plug-in. Furthermore, the code should not assume that the plug-in was started successfully, as this method will be invoked in the event of a failure during startup.

Note 1: If a plug-in has been started, this method will be automatically invoked by the platform when the platform is shut down.

Note 2: This method is intended to perform simple termination of the plug-in environment. The platform may terminate invocations that do not complete in a timely fashion.

Clients must never explicitly call this method.

Overrides:

shutdown in class Plugin

Throws:

CoreException - if this method fails to shut down this plug-in

See Also:

Plugin.shutdown()

getPreferences

public AntCorePreferences getPreferences()

Returns an object representing this plug-in's preferences.

Returns:

the Ant core object representing the preferences for this plug-in.

setRunningHeadless

protected void setRunningHeadless()

Set this plug-in's preferences for running headless.

getPlugin

public static AntCorePlugin getPlugin()

Returns this plug-in instance.

Returns:

the single instance of this plug-in runtime class

getNewClassLoader

protected ClassLoader getNewClassLoader()

Returns a new class loader to use when executing Ant builds.

Returns:

the new class loader

log

public static void log(Throwable t)

Logs the specified throwable with this plug-in's log.

Parameters:

t - throwable to log

Since:

2.1