org.eclipse.wst.server.core.model
Class RuntimeTargetHandlerDelegate

java.lang.Object
  org.eclipse.wst.server.core.model.RuntimeTargetHandlerDelegate

public abstract class RuntimeTargetHandlerDelegate

extends java.lang.Object

A runtime target handler is used when associating a runtime with a particular project. It has the ability to make any changes it requires on the projects - adding or removing files, setting up the classpath, etc.

This abstract class is intended to be extended only by clients to extend the runtimeTargetHandlers extension point.

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Constructor Summary

RuntimeTargetHandlerDelegate()

Method Summary

IRuntimeTargetHandler	getRuntimeTargetHandler() Returns the runtime target handler that this delegate is associated with.
void	initialize(IRuntimeTargetHandler newHandler) Initializes the runtime target handler.
abstract void	removeRuntimeTarget(org.eclipse.core.resources.IProject project, IRuntime runtime, org.eclipse.core.runtime.IProgressMonitor monitor) Remove the runtime target from the given project.
abstract void	setRuntimeTarget(org.eclipse.core.resources.IProject project, IRuntime runtime, org.eclipse.core.runtime.IProgressMonitor monitor) Set the runtime target on the given project.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeTargetHandlerDelegate

public RuntimeTargetHandlerDelegate()

Method Detail

initialize

public final void initialize(IRuntimeTargetHandler newHandler)

Initializes the runtime target handler.

Parameters:

newHandler - the new handler

getRuntimeTargetHandler

public IRuntimeTargetHandler getRuntimeTargetHandler()

Returns the runtime target handler that this delegate is associated with.

Returns:

the runtime target handler

setRuntimeTarget

public abstract void setRuntimeTarget(org.eclipse.core.resources.IProject project,
                                      IRuntime runtime,
                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws org.eclipse.core.runtime.CoreException

Set the runtime target on the given project.

Parameters:

project - the project to set the runtime on

runtime - the target runtime

monitor - a progress monitor, or null if progress reporting and cancellation are not desired

Throws:

org.eclipse.core.runtime.CoreException - thrown if there is a problem setting the runtime

removeRuntimeTarget

public abstract void removeRuntimeTarget(org.eclipse.core.resources.IProject project,
                                         IRuntime runtime,
                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                  throws org.eclipse.core.runtime.CoreException

Remove the runtime target from the given project.

Parameters:

project - the project to remove the runtime from

runtime - the target runtime

monitor - a progress monitor, or null if progress reporting and cancellation are not desired

Throws:

org.eclipse.core.runtime.CoreException - thrown if there is a problem removing the runtime