org.eclipse.ant.core
Class AntCorePlugin

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

All Implemented Interfaces:

org.eclipse.ant.internal.core.IAntCoreConstants

public class AntCorePlugin

extends Plugin

implements org.eclipse.ant.internal.core.IAntCoreConstants

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 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

Fields inherited from interface org.eclipse.ant.internal.core.IAntCoreConstants

DEFAULT_BUILD_FILENAME, ERROR_LIBRARY_NOT_SPECIFIED, ERROR_MALFORMED_URL, ERROR_RUNNING_SCRIPT, PREFERENCE_TASKS, PREFERENCE_TYPES, PREFERENCE_URLS, PREFIX_TASK, PREFIX_TYPE, PREFIX_URL

Constructor Summary

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

Method Summary

static AntCorePlugin	getPlugin() Returns this plug-in instance.
org.eclipse.ant.internal.core.AntCorePreferences	getPreferences() Returns an object representing this plug-in's preferences.
void	shutdown() Shuts down this plug-in and discards all plug-in state.
void	startup() Starts up this plug-in.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

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

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

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. Cliens must never explicitly instantiate a plug-in runtime class.

Method Detail

startup

public void startup()
             throws CoreException

Description copied from class: Plugin

Starts up this plug-in.

This method should be overridden in subclasses that need to do something when this plug-in is started. Implementors should call the inherited method to ensure that any system requirements can be met.

If this method throws an exception, it is taken as an indication that plug-in initialization has failed; as a result, the plug-in will not be activated; moreover, the plug-in will be marked as disabled and ineligible for activation for the duration.

Plug-in startup code should be robust. In the event of a startup failure, the plug-in's shutdown method will be invoked automatically, in an attempt to close open files, etc.

Note 1: This method is automatically invoked by the platform the first time any code in the plug-in is executed.

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

Note 3: The class loader typically has monitors acquired during invocation of this method. It is strongly recommended that this method avoid synchronized blocks or other thread locking mechanisms, as this would lead to deadlock vulnerability.

Clients must never explicitly call this method.

Overrides:

startup in class Plugin

Throws:

CoreException - if this plug-in did not start up properly

See Also:

Plugin.startup()

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 org.eclipse.ant.internal.core.AntCorePreferences getPreferences()

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

This method is for internal use by the platform-related plug-ins. Clients should not call this method.

getPlugin

public static AntCorePlugin getPlugin()

Returns this plug-in instance.

Returns:

the single instance of this plug-in runtime class