Package org.eclipse.team.core

Class ProjectSetSerializationContext

  • public class ProjectSetSerializationContext
extends java.lang.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 filename
      ProjectSetSerializationContext​(java.lang.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.
      java.lang.String getFilename()
      Return the name of the file to or from which the project set is being loaded or saved.
      java.lang.Object getProperty​(java.lang.String key)
      Return the property for the given key or null if the property is not set.
      java.lang.Object getShell()
      Return a org.eclipse.swt.Shell if there is a UI context or null if executing headless.
      void setProperty​(java.lang.String key, java.lang.Object value)
      Set a property of this context.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProjectSetSerializationContext

        public ProjectSetSerializationContext()
        Create a serialization context with no filename

      • ProjectSetSerializationContext

        public ProjectSetSerializationContext​(java.lang.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 or null

    • 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. (not null, contains no nulls)
        Returns:
        an array of zero or more projects that should be overwritten or null if the operation is to be canceled
        Throws:
        TeamException - on failure

      • getShell

        public java.lang.Object getShell()
        Return a org.eclipse.swt.Shell if there is a UI context or null if executing headless.
        Returns:
        the shell or null

      • getFilename

        public java.lang.String getFilename()
        Return the name of the file to or from which the project set is being loaded or saved. This may be null.
        Returns:
        the filename or null

      • setProperty

        public void setProperty​(java.lang.String key,
                        java.lang.Object value)
        Set a property of this context.
        Parameters:
        key - the property key
        value - the property value
        Since:
        3.3

      • getProperty

        public java.lang.Object getProperty​(java.lang.String key)
        Return the property for the given key or null if the property is not set.
        Parameters:
        key - the property key
        Returns:
        the property value
        Since:
        3.3