Package org.eclipse.ui.ide.undo

Class ResourceDescription

java.lang.Object
org.eclipse.ui.ide.undo.ResourceDescription
@Deprecated public abstract class ResourceDescription extends Object
Deprecated.
Replaced by IResourceSnapshot and ResourceSnapshotFactory in the org.eclipse.core.resources.undo.snapshot package
ResourceDescription is a lightweight description that describes the common attributes of a resource to be created. This class is not intended to be extended by clients.
Since:
3.3

  • Constructor Details

    • ResourceDescription

      public ResourceDescription()
      Deprecated.

  • Method Details

    • fromResource

      public static ResourceDescription fromResource(IResource resource)
      Deprecated.
      Create a resource description given the specified resource. The resource is assumed to exist.
      Parameters:
      resource - the resource from which a description should be created
      Returns:
      the resource description

    • createResourceHandle

      public abstract IResource createResourceHandle()
      Deprecated.
      Create a resource handle that can be used to create a resource from this resource description. This handle can be used to create the actual resource, or to describe the creation to a resource delta factory.
      Returns:
      the resource handle that can be used to create a resource from this description

    • getName

      public abstract String getName()
      Deprecated.
      Get the name of this resource.
      Returns:
      the name of the Resource

    • createResource

      public abstract IResource createResource(IProgressMonitor monitor) throws CoreException
      Deprecated.
      Create an existent resource from this resource description.
      Parameters:
      monitor - the progress monitor to use
      Returns:
      a resource that has the attributes of this resource description
      Throws:
      CoreException - if creation failed

    • createExistentResourceFromHandle

      public abstract void createExistentResourceFromHandle(IResource resource, IProgressMonitor monitor) throws CoreException
      Deprecated.
      Given a resource handle, create an actual resource with the attributes of the receiver resource description.
      Parameters:
      resource - the resource handle
      monitor - the progress monitor to be used when creating the resource
      Throws:
      CoreException - if creation failed

    • isValid

      public abstract boolean isValid()
      Deprecated.
      Return a boolean indicating whether this resource description has enough information to create a resource.
      Returns:
      true if the resource can be created, and false if it does not have enough information

    • recordStateFromHistory

      public abstract void recordStateFromHistory(IResource resource, IProgressMonitor monitor) throws CoreException
      Deprecated.
      Record the appropriate state of this resource description using any available resource history.
      Parameters:
      resource - the resource whose state is to be recorded.
      monitor - the progress monitor to be used
      Throws:
      CoreException - in case of error

    • verifyExistence

      public abstract boolean verifyExistence(boolean checkMembers)
      Deprecated.
      Return a boolean indicating whether this description represents an existent resource.
      Parameters:
      checkMembers - Use true if members should also exist in order for this description to be considered existent. A value of false indicates that the existence of members does not matter.
      Returns:
      a boolean indicating whether this description represents an existent resource.