org.eclipse.hyades.test.tools.core.internal.common.codegen
Interface IProjectDependencyUpdater

All Known Implementing Classes:

AutoGUIGenerator.AutoGUIProjectDependencyUpdater, AutomaticDependencyUpdater, DelegateProjectDependencyUpdater, JavaProjectDependencyUpdater, JUnitGenerator.JUnitProjectDependencyUpdater, PluginProjectDependencyUpdater

public interface IProjectDependencyUpdater

Updates a project dependencies (usually for the purpose of updating the classpath available to this project). Implementations should not perform any modification until adjustProject(IProject, IProgressMonitor) is called.

Method Summary

void	addRequiredPlugin(java.lang.String pluginId, java.lang.String jarName) Add to the project dependencies the specified plugin.
void	addRequiredProject(org.eclipse.core.resources.IProject project) Add to the project dependencies the specified project.
void	adjustProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Performs the actual change to the specified project.
java.util.Collection	previewAdjustProject(org.eclipse.core.resources.IProject project) Determines which changes the call to adjustProject would make.

Method Detail

addRequiredPlugin

void addRequiredPlugin(java.lang.String pluginId,
                       java.lang.String jarName)

Add to the project dependencies the specified plugin.

Parameters:

pluginName - The name of the required plugin.

jarName - An optional jar name. This parameter may be used as a hint by some implementations. null is valid and means that the complete libraries of the specified plugin should be taken into account.

addRequiredProject

void addRequiredProject(org.eclipse.core.resources.IProject project)

Add to the project dependencies the specified project.

Parameters:

project - A project.

adjustProject

void adjustProject(org.eclipse.core.resources.IProject project,
                   org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws org.eclipse.core.runtime.CoreException

Performs the actual change to the specified project. This project specification is updated according to the dependencies that have been registered previously.

Parameters:

project -

monitor -

Throws:

org.eclipse.core.runtime.CoreException

previewAdjustProject

java.util.Collection previewAdjustProject(org.eclipse.core.resources.IProject project)

Determines which changes the call to adjustProject would make. Note for later release: the signature and semantics of this method should be changed to "Is there any change to make to the project?", so this method should return a boolean. Returning the collection of entries to added is too limiting for the implementations, and furthermore this is not a useful information since all callers to this method just test whether the returned list is empty or not.

Parameters:

project -

Returns:

A collection of strings indicating the dependencies that need to be added to the project. An empty list indicates that the project is already up-to-date and does not need adjusting.