Package org.eclipse.team.core
Class ProjectSetSerializationContext
- java.lang.Object
-
- org.eclipse.team.core.ProjectSetSerializationContext
-
public class ProjectSetSerializationContext extends Object
The context in which project serialization occurs. The class may be subclassed to represent different serialization contexts.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description ProjectSetSerializationContext()Create a serialization context with no filenameProjectSetSerializationContext(String filename)Create a serialization context and set the filename of the file that does or is to contain the project set.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IProject[]confirmOverwrite(IProject[] projects)Given an array of projects that currently exist in the workspace determine which of those projects should be overwritten.StringgetFilename()Return the name of the file to or from which the project set is being loaded or saved.ObjectgetProperty(String key)Return the property for the given key ornullif the property is not set.ObjectgetShell()Return a org.eclipse.swt.Shell if there is a UI context ornullif executing headless.voidsetProperty(String key, Object value)Set a property of this context.
-
-
-
Constructor Detail
-
ProjectSetSerializationContext
public ProjectSetSerializationContext()
Create a serialization context with no filename
-
ProjectSetSerializationContext
public ProjectSetSerializationContext(String filename)
Create a serialization context and set the filename of the file that does or is to contain the project set.- Parameters:
filename- a filename ornull
-
-
Method Detail
-
confirmOverwrite
public IProject[] confirmOverwrite(IProject[] projects) throws TeamException
Given an array of projects that currently exist in the workspace determine which of those projects should be overwritten.This default implementation always returns an empty array indicating that no existing projects should be overwritten. Subclasses may override this as appropriate.
- Parameters:
projects- an array of projects currently existing in the workspace that are desired to be overwritten. (notnull, contains nonulls)- Returns:
- an array of zero or more projects that should be overwritten
or
nullif the operation is to be canceled - Throws:
TeamException
-
getShell
public Object getShell()
Return a org.eclipse.swt.Shell if there is a UI context ornullif executing headless.- Returns:
- the shell or
null
-
getFilename
public String getFilename()
Return the name of the file to or from which the project set is being loaded or saved. This may benull.- Returns:
- the filename or
null
-
setProperty
public void setProperty(String key, Object value)
Set a property of this context.- Parameters:
key- the property keyvalue- the property value- Since:
- 3.3
-
-