org.eclipse.jdt.internal.launching

Class LaunchingPlugin

java.lang.Object

Plugin

org.eclipse.jdt.internal.launching.LaunchingPlugin

All Implemented Interfaces:

IVMInstallChangedListener

public class LaunchingPlugin
extends Plugin
implements IVMInstallChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_LAUNCH_TEMP_FILES list of temp files for the launch (separated by the path separator char).
static boolean	DEBUG Whether debug options are turned on for this plug-in.
static java.lang.String	DEBUG_FLAG
static boolean	DEBUG_JRE_CONTAINER
static java.lang.String	DEBUG_JRE_CONTAINER_FLAG
static java.lang.String	ID_EXTENSION_POINT_RUNTIME_CLASSPATH_ENTRIES Identifier for 'runtimeClasspathEntries' extension point
static java.lang.String	ID_EXTENSION_POINT_VM_CONNECTORS Identifier for 'vmConnectors' extension point
static java.lang.String	ID_PLUGIN The id of the JDT launching plug-in (value "org.eclipse.jdt.launching").
static java.lang.String	LAUNCH_TEMP_FILE_PREFIX prefix for temp files

Fields inherited from interface org.eclipse.jdt.launching.IVMInstallChangedListener

PROPERTY_INSTALL_LOCATION, PROPERTY_JAVADOC_LOCATION, PROPERTY_LIBRARY_LOCATIONS, PROPERTY_NAME, PROPERTY_VM_ARGUMENTS

Constructor Summary

Constructors

Constructor and Description
LaunchingPlugin() Constructor

Method Summary

Modifier and Type	Method and Description
protected static void	abort(java.lang.String message, java.lang.Throwable exception) Throws an exception with the given message and underlying exception.
void	defaultVMInstallChanged(IVMInstall previous, IVMInstall current) Notification that the workspace default VM install has changed.
static LaunchingPlugin	getDefault() Returns the singleton instance of LaunchingPlugin
static java.io.File	getFileInPlugin(IPath path) Return a java.io.File object that corresponds to the specified IPath in the plug-in directory.
static LibraryInfo	getLibraryInfo(java.lang.String javaInstallPath) Returns the library info that corresponds to the specified JRE install path, or null if none.
static javax.xml.parsers.DocumentBuilder	getParser() Returns a shared XML parser.
static java.lang.String	getUniqueIdentifier() Convenience method which returns the unique identifier of this plug-in.
IVMConnector	getVMConnector(java.lang.String id) Returns the VM connector with the specified id, or null if none.
IVMConnector[]	getVMConnectors() Returns all VM connector extensions.
void	handleDebugEvents(DebugEvent[] events)
boolean	isIgnoreVMDefPropertyChangeEvents() Returns if VM property changed event should be ignored or not
static boolean	isVMLogging()
void	launchesAdded(ILaunch[] launches)
void	launchesChanged(ILaunch[] launches)
void	launchesRemoved(ILaunch[] launches)
static void	log(IStatus status) Logs the specified status
IRuntimeClasspathEntry2	newRuntimeClasspathEntry(java.lang.String id) Returns a new runtime classpath entry of the specified type.
void	optionsChanged(DebugOptions options)
void	preferenceChange(PreferenceChangeEvent event)
protected void	processVMPrefsChanged(java.lang.String oldValue, java.lang.String newValue) Check for differences between the old & new sets of installed JREs.
void	resourceChanged(IResourceChangeEvent event)
static boolean	sameURL(java.net.URL url1, java.net.URL url2) Compares two URL for equality, but do not connect to do DNS resolution
void	setIgnoreVMDefPropertyChangeEvents(boolean ignore) Allows VM property change events to be ignored
static void	setLibraryInfo(java.lang.String javaInstallPath, LibraryInfo info) Sets the library info that corresponds to the specified JRE install path.
void	start(BundleContext context)
void	stop(BundleContext context) Clears zip file cache.
static boolean	timeStampChanged(java.lang.String location) Checks to see if the time stamp of the file describe by the given location string has been modified since the last recorded time stamp.
static void	trace(java.lang.String message) Prints the given message to System.out and to the OSGi tracing (if enabled)
static void	trace(java.lang.String option, java.lang.String message, java.lang.Throwable throwable) Prints the given message to System.out and to the OSGi tracing (if started)
void	vmAdded(IVMInstall vm) Notification that a VM has been created.
void	vmChanged(PropertyChangeEvent event) Notification that a property of a VM install has changed.
void	vmRemoved(IVMInstall vm) Notification that a VM has been disposed.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Whether debug options are turned on for this plug-in.

DEBUG_JRE_CONTAINER

public static boolean DEBUG_JRE_CONTAINER

DEBUG_JRE_CONTAINER_FLAG

public static final java.lang.String DEBUG_JRE_CONTAINER_FLAG

See Also:

Constant Field Values

DEBUG_FLAG

public static final java.lang.String DEBUG_FLAG

See Also:

Constant Field Values

ATTR_LAUNCH_TEMP_FILES

public static final java.lang.String ATTR_LAUNCH_TEMP_FILES

list of temp files for the launch (separated by the path separator char). Files must start with LAUNCH_TEMP_FILE_PREFIX and will be deleted once the process is terminated

See Also:

Constant Field Values

LAUNCH_TEMP_FILE_PREFIX

public static final java.lang.String LAUNCH_TEMP_FILE_PREFIX

prefix for temp files

See Also:

Constant Field Values

ID_PLUGIN

public static final java.lang.String ID_PLUGIN

The id of the JDT launching plug-in (value "org.eclipse.jdt.launching").

See Also:

Constant Field Values

ID_EXTENSION_POINT_VM_CONNECTORS

public static final java.lang.String ID_EXTENSION_POINT_VM_CONNECTORS

Identifier for 'vmConnectors' extension point

See Also:

Constant Field Values

ID_EXTENSION_POINT_RUNTIME_CLASSPATH_ENTRIES

public static final java.lang.String ID_EXTENSION_POINT_RUNTIME_CLASSPATH_ENTRIES

Identifier for 'runtimeClasspathEntries' extension point

See Also:

Constant Field Values

Constructor Detail

LaunchingPlugin

public LaunchingPlugin()

Constructor

Method Detail

getLibraryInfo

public static LibraryInfo getLibraryInfo(java.lang.String javaInstallPath)

Returns the library info that corresponds to the specified JRE install path, or null if none.

Parameters:

javaInstallPath - the absolute path to the java executable

Returns:

the library info that corresponds to the specified JRE install path, or null if none

setLibraryInfo

public static void setLibraryInfo(java.lang.String javaInstallPath,
                                  LibraryInfo info)

Sets the library info that corresponds to the specified JRE install path.

Parameters:

javaInstallPath - home location for a JRE

info - the library information, or null to remove

isVMLogging

public static boolean isVMLogging()

getFileInPlugin

public static java.io.File getFileInPlugin(IPath path)

Return a java.io.File object that corresponds to the specified IPath in the plug-in directory.

Parameters:

path - the path to look for in the launching bundle

Returns:

the File from the bundle or null

getUniqueIdentifier

public static java.lang.String getUniqueIdentifier()

Convenience method which returns the unique identifier of this plug-in.

Returns:

the id of the LaunchingPlugin

getDefault

public static LaunchingPlugin getDefault()

Returns the singleton instance of LaunchingPlugin

Returns:

the singleton instance of LaunchingPlugin

log

public static void log(IStatus status)

Logs the specified status

Parameters:

status - the status to log

stop

public void stop(BundleContext context)
          throws java.lang.Exception

Clears zip file cache. Shutdown the launch configuration helper.

Throws:

java.lang.Exception

See Also:

Plugin#stop(BundleContext)

start

public void start(BundleContext context)
           throws java.lang.Exception

Throws:

java.lang.Exception

getVMConnector

public IVMConnector getVMConnector(java.lang.String id)

Returns the VM connector with the specified id, or null if none.

Parameters:

id - connector identifier

Returns:

VM connector

getVMConnectors

public IVMConnector[] getVMConnectors()

Returns all VM connector extensions.

Returns:

VM connectors

newRuntimeClasspathEntry

public IRuntimeClasspathEntry2 newRuntimeClasspathEntry(java.lang.String id)
                                                 throws CoreException

Returns a new runtime classpath entry of the specified type.

Parameters:

id - extension type id

Returns:

new uninitialized runtime classpath entry

Throws:

CoreException - if unable to create an entry

processVMPrefsChanged

protected void processVMPrefsChanged(java.lang.String oldValue,
                                     java.lang.String newValue)

Check for differences between the old & new sets of installed JREs. Differences may include additions, deletions and changes. Take appropriate action for each type of difference. When importing preferences, TWO propertyChange events are fired. The first has an old value but an empty new value. The second has a new value, but an empty old value. Normal user changes to the preferences result in a single propertyChange event, with both old and new values populated. This method handles both types of notification.

Parameters:

oldValue - the old preference value

newValue - the new preference value

defaultVMInstallChanged

public void defaultVMInstallChanged(IVMInstall previous,
                                    IVMInstall current)

Description copied from interface: IVMInstallChangedListener

Notification that the workspace default VM install has changed.

Specified by:

defaultVMInstallChanged in interface IVMInstallChangedListener

Parameters:

previous - the VM install that was previously assigned to the workspace, possibly null

current - the VM install that is currently assigned to the workspace, possibly null

vmAdded

public void vmAdded(IVMInstall vm)

Description copied from interface: IVMInstallChangedListener

Notification that a VM has been created.

Specified by:

vmAdded in interface IVMInstallChangedListener

Parameters:

vm - the vm that has been created

vmChanged

public void vmChanged(PropertyChangeEvent event)

Description copied from interface: IVMInstallChangedListener

Notification that a property of a VM install has changed.

Specified by:

vmChanged in interface IVMInstallChangedListener

Parameters:

event - event describing the change. The VM that has changed is the source object associated with the event.

vmRemoved

public void vmRemoved(IVMInstall vm)

Description copied from interface: IVMInstallChangedListener

Notification that a VM has been disposed.

Specified by:

vmRemoved in interface IVMInstallChangedListener

Parameters:

vm - the vm that has been disposed

resourceChanged

public void resourceChanged(IResourceChangeEvent event)

setIgnoreVMDefPropertyChangeEvents

public void setIgnoreVMDefPropertyChangeEvents(boolean ignore)

Allows VM property change events to be ignored

Parameters:

ignore - if we should ignore VM property changed events or not

isIgnoreVMDefPropertyChangeEvents

public boolean isIgnoreVMDefPropertyChangeEvents()

Returns if VM property changed event should be ignored or not

Returns:

if VM property changed event should be ignored or not

timeStampChanged

public static boolean timeStampChanged(java.lang.String location)

Checks to see if the time stamp of the file describe by the given location string has been modified since the last recorded time stamp. If there is no last recorded time stamp we assume it has changed. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=266651 for more information

Parameters:

location - the location of the SDK we want to check the time stamp for

Returns:

true if the time stamp has changed compared to the cached one or if there is no recorded time stamp, false otherwise.

Since:

3.7

launchesRemoved

public void launchesRemoved(ILaunch[] launches)

launchesAdded

public void launchesAdded(ILaunch[] launches)

launchesChanged

public void launchesChanged(ILaunch[] launches)

handleDebugEvents

public void handleDebugEvents(DebugEvent[] events)

getParser

public static javax.xml.parsers.DocumentBuilder getParser()
                                                   throws CoreException

Returns a shared XML parser.

Returns:

an XML parser

Throws:

CoreException - if unable to create a parser

Since:

3.0

abort

protected static void abort(java.lang.String message,
                            java.lang.Throwable exception)
                     throws CoreException

Throws an exception with the given message and underlying exception.

Parameters:

message - error message

exception - underlying exception or null if none

Throws:

CoreException - if an exception occurs

sameURL

public static boolean sameURL(java.net.URL url1,
                              java.net.URL url2)

Compares two URL for equality, but do not connect to do DNS resolution

Parameters:

url1 - a given URL

url2 - another given URL to compare to url1

Returns:

true if the URLs are equal, false otherwise

Since:

3.5

preferenceChange

public void preferenceChange(PreferenceChangeEvent event)

optionsChanged

public void optionsChanged(DebugOptions options)

trace

public static void trace(java.lang.String option,
                         java.lang.String message,
                         java.lang.Throwable throwable)

Prints the given message to System.out and to the OSGi tracing (if started)

Parameters:

option - the option or null

message - the message to print or null

throwable - the Throwable or null

Since:

3.8

trace

public static void trace(java.lang.String message)

Prints the given message to System.out and to the OSGi tracing (if enabled)

Parameters:

message - the message or null

Since:

3.8