Package org.eclipse.ui.ide.undo

Class CreateFileOperation

java.lang.Object
org.eclipse.core.commands.operations.AbstractOperation
org.eclipse.ui.ide.undo.AbstractWorkspaceOperation
org.eclipse.ui.ide.undo.CreateFileOperation
All Implemented Interfaces:
IAdvancedUndoableOperation, IAdvancedUndoableOperation2, IUndoableOperation
public class CreateFileOperation extends AbstractWorkspaceOperation
A CreateFileOperation represents an undoable operation for creating a file in the workspace. If a link location is specified, the file is considered to be linked to the file at the specified location. If a link location is not specified, the file will be created in the location specified by the handle, and the entire containment path of the file will be created if it does not exist. The file should not already exist, and the existence of the containment path should not be changed between the time this operation is created and the time it is executed.

Clients may call the public API from a background thread.

This class is intended to be instantiated and used by clients. It is not intended to be subclassed by clients.

Since:
3.3
Restriction:
This class is not intended to be subclassed by clients.

  • Field Details

  • Constructor Details

    • CreateFileOperation

      public CreateFileOperation(IFile fileHandle, URI linkLocation, InputStream contents, String label)
      Create a CreateFileOperation
      Parameters:
      fileHandle - the file to be created
      linkLocation - the location of the file if it is to be linked
      contents - the initial contents of the file, or null if there is to be no contents
      label - the label of the operation

  • Method Details

    • computeExecutionStatus

      public IStatus computeExecutionStatus(IProgressMonitor monitor)
      Description copied from class: AbstractWorkspaceOperation
      Return a status indicating the projected outcome of executing the receiver. This method is not called by the operation history, but instead is used by clients (such as implementers of IOperationApprover2) who wish to perform advanced validation of an operation before attempting to execute it. If an ERROR status is returned, the operation will not proceed and the user notified if deemed necessary by the caller. The validity flag on the operation should be marked as invalid. If an OK status is returned, the operation will proceed. The caller must interpret any other returned status severity, and may choose to prompt the user as to how to proceed. If there are multiple conditions that result in an ambiguous status severity, it is best for the implementor of this method to consult the user as to how to proceed for each one, and return an OK or ERROR status that accurately reflects the user's wishes, or to return a multi-status that accurately describes all of the issues at hand, so that the caller may potentially consult the user. (Note that the user should not be consulted at all if a client has called AbstractWorkspaceOperation.setQuietCompute(boolean) with a value of true.) This implementation computes the validity of execution by computing the resource delta that would be generated on execution, and checking whether any registered model providers are affected by the operation.
      Specified by:
      computeExecutionStatus in interface IAdvancedUndoableOperation2
      Parameters:
      monitor - the progress monitor to be used for computing the status
      Returns:
      the status indicating the projected outcome of executing the receiver
      See Also:

    • doExecute

      protected void doExecute(IProgressMonitor monitor, IAdaptable uiInfo) throws CoreException
      Description copied from class: AbstractWorkspaceOperation
      Perform the specific work involved in executing this operation.
      Specified by:
      doExecute in class AbstractWorkspaceOperation
      Parameters:
      monitor - the progress monitor to use for the operation
      uiInfo - the IAdaptable (or null) provided by the caller in order to supply UI information for prompting the user if necessary. When this parameter is not null, it contains an adapter for the org.eclipse.swt.widgets.Shell.class
      Throws:
      CoreException - propagates any CoreExceptions thrown from the resources API

    • doUndo

      protected void doUndo(IProgressMonitor monitor, IAdaptable uiInfo) throws CoreException
      Description copied from class: AbstractWorkspaceOperation
      Perform the specific work involved in undoing this operation.
      Specified by:
      doUndo in class AbstractWorkspaceOperation
      Parameters:
      monitor - the progress monitor to use for the operation
      uiInfo - the IAdaptable (or null) provided by the caller in order to supply UI information for prompting the user if necessary. When this parameter is not null, it contains an adapter for the org.eclipse.swt.widgets.Shell.class
      Throws:
      CoreException - propagates any CoreExceptions thrown from the resources API

    • updateResourceChangeDescriptionFactory

      protected boolean updateResourceChangeDescriptionFactory(IResourceChangeDescriptionFactory factory, int operation)
      Description copied from class: AbstractWorkspaceOperation
      Update the provided resource change description factory so it can generate a resource delta describing the result of an undo or redo. Return a boolean indicating whether any update was done. The default implementation does not update the factory. Subclasses are expected to override this method to more specifically describe their modifications to the workspace.
      Overrides:
      updateResourceChangeDescriptionFactory in class AbstractWorkspaceOperation
      Parameters:
      factory - the factory to update
      operation - an integer indicating whether the change is part of an execute, undo, or redo
      Returns:
      a boolean indicating whether the factory was updated.

    • getExecuteSchedulingRule

      protected ISchedulingRule getExecuteSchedulingRule()
      Description copied from class: AbstractWorkspaceOperation
      Return a scheduling rule appropriate for executing this operation. The default implementation is to return a rule that locks out the entire workspace. Subclasses are encouraged to provide more specific rules that affect only their resources.
      Overrides:
      getExecuteSchedulingRule in class AbstractWorkspaceOperation
      Returns:
      the scheduling rule to use when executing this operation, or null if there are no scheduling restrictions for this operation.
      See Also:

    • getUndoSchedulingRule

      protected ISchedulingRule getUndoSchedulingRule()
      Description copied from class: AbstractWorkspaceOperation
      Return a scheduling rule appropriate for undoing this operation. The default implementation is to return a rule that locks out the entire workspace. Subclasses are encouraged to provide more specific rules that affect only their resources.
      Overrides:
      getUndoSchedulingRule in class AbstractWorkspaceOperation
      Returns:
      the scheduling rule to use when undoing this operation, or null if there are no scheduling restrictions for this operation.
      See Also:

    • computeUndoableStatus

      public IStatus computeUndoableStatus(IProgressMonitor monitor)
      Description copied from class: AbstractWorkspaceOperation
      Return a status indicating the projected outcome of undoing the receiver. This method is not called by the operation history, but instead is used by clients (such as implementers of IOperationApprover2) who wish to perform advanced validation of an operation before attempting to undo it. If an ERROR status is returned, the undo will not proceed and the user notified if deemed necessary by the caller. The validity flag on the operation should be marked as invalid. If an OK status is returned, the undo will proceed. The caller must interpret any other returned status severity, and may choose to prompt the user as to how to proceed. If there are multiple conditions that result in an ambiguous status severity, it is best for the implementor of this method to consult the user as to how to proceed for each one, and return an OK or ERROR status that accurately reflects the user's wishes, or to return a multi-status that accurately describes all of the issues at hand, so that the caller may potentially consult the user. (Note that the user should not be consulted at all if a client has called AbstractWorkspaceOperation.setQuietCompute(boolean) with a value of true.) This implementation computes the validity of undo by computing the resource delta that would be generated on undo, and checking whether any registered model providers are affected by the operation.
      Specified by:
      computeUndoableStatus in interface IAdvancedUndoableOperation
      Overrides:
      computeUndoableStatus in class AbstractWorkspaceOperation
      Parameters:
      monitor - the progress monitor to be used for computing the status
      Returns:
      the status indicating the projected outcome of undoing the receiver
      See Also:

    • computeRedoableStatus

      public IStatus computeRedoableStatus(IProgressMonitor monitor)
      Description copied from class: AbstractWorkspaceOperation
      Return a status indicating the projected outcome of redoing the receiver. This method is not called by the operation history, but instead is used by clients (such as implementers of IOperationApprover2) who wish to perform advanced validation of an operation before attempting to redo it. If an ERROR status is returned, the redo will not proceed and the user notified if deemed necessary by the caller. The validity flag on the operation should be marked as invalid. If an OK status is returned, the redo will proceed. The caller must interpret any other returned status severity, and may choose to prompt the user as to how to proceed. If there are multiple conditions that result in an ambiguous status severity, it is best for the implementor of this method to consult the user as to how to proceed for each one, and return an OK or ERROR status that accurately reflects the user's wishes, or to return a multi-status that accurately describes all of the issues at hand, so that the caller may potentially consult the user. (Note that the user should not be consulted at all if a client has called AbstractWorkspaceOperation.setQuietCompute(boolean) with a value of true.) This implementation computes the validity of redo by computing the resource delta that would be generated on redo, and checking whether any registered model providers are affected by the operation.
      Specified by:
      computeRedoableStatus in interface IAdvancedUndoableOperation
      Overrides:
      computeRedoableStatus in class AbstractWorkspaceOperation
      Parameters:
      monitor - the progress monitor to be used for computing the status
      Returns:
      the status indicating the projected outcome of redoing the receiver
      See Also:

    • delete

      protected void delete(IProgressMonitor monitor, IAdaptable uiInfo, boolean deleteContent) throws CoreException
      Delete any resources known by this operation. Store enough information to undo and redo the operation.
      Parameters:
      monitor - the progress monitor to use for the operation
      uiInfo - the IAdaptable (or null) provided by the caller in order to supply UI information for prompting the user if necessary. When this parameter is not null, it contains an adapter for the org.eclipse.swt.widgets.Shell.class
      deleteContent - true if the content of any known projects should be deleted along with the project. false if project content should not be deleted.
      Throws:
      CoreException - propagates any CoreExceptions thrown from the resources API

    • recreate

      protected void recreate(IProgressMonitor monitor, IAdaptable uiInfo) throws CoreException
      Recreate any resources known by this operation. Store enough information to undo and redo the operation.
      Parameters:
      monitor - the progress monitor to use for the operation
      uiInfo - the IAdaptable (or null) provided by the caller in order to supply UI information for prompting the user if necessary. When this parameter is not null, it contains an adapter for the org.eclipse.swt.widgets.Shell.class
      Throws:
      CoreException - propagates any CoreExceptions thrown from the resources API

    • computeCreateStatus

      protected IStatus computeCreateStatus(boolean allowOverwrite)
      Compute the status for creating resources from the descriptions. A status severity of OK indicates that the create is likely to be successful. A status severity of ERROR indicates that the operation is no longer valid. Other status severities are open to interpretation by the caller. Note this method may be called on initial creation of a resource, or when a create or delete operation is being undone or redone. Therefore, this method should check conditions that can change over the life of the operation, such as the existence of the information needed to carry out the operation. One-time static checks should typically be done by the caller (such as the action that creates the operation) so that the user is not continually prompted or warned about conditions that were acceptable at the time of original execution.
      Parameters:
      allowOverwrite - a boolean that specifies whether resource creation should be allowed to overwrite an existent resource.

    • computeDeleteStatus

      protected IStatus computeDeleteStatus()
      Compute the status for deleting resources. A status severity of OK indicates that the delete is likely to be successful. A status severity of ERROR indicates that the operation is no longer valid. Other status severities are open to interpretation by the caller. Note this method may be called on initial deletion of a resource, or when a create or delete operation is being undone or redone. Therefore, this method should check conditions that can change over the life of the operation, such as the existence of the resources to be deleted. One-time static checks should typically be done by the caller (such as the action that creates the operation) so that the user is not continually prompted or warned about conditions that were acceptable at the time of original execution.

    • setResourceDescriptions

      protected void setResourceDescriptions(IResourceSnapshot<? extends IResource>[] descriptions)
      Set the array of resource descriptions describing resources to be restored when undoing or redoing this operation.
      Parameters:
      descriptions - the array of resource descriptions

    • appendDescriptiveText

      protected void appendDescriptiveText(StringBuffer text)
      Description copied from class: AbstractWorkspaceOperation
      Append any descriptive text to the specified string buffer to be shown in the receiver's AbstractWorkspaceOperation.toString() text.

      Note that this method is not intend to be subclassed by clients.

      Overrides:
      appendDescriptiveText in class AbstractWorkspaceOperation
      Parameters:
      text - the StringBuffer on which to append the text

    • computeCreateSchedulingRule

      protected ISchedulingRule computeCreateSchedulingRule()
      Compute a scheduling rule for creating resources.
      Returns:
      a scheduling rule appropriate for creating the resources specified in the resource descriptions

    • computeDeleteSchedulingRule

      protected ISchedulingRule computeDeleteSchedulingRule()
      Compute a scheduling rule for deleting resources.
      Returns:
      a scheduling rule appropriate for deleting the resources specified in the receiver.

    • setTargetResources

      protected void setTargetResources(IResource[] targetResources)
      Description copied from class: AbstractWorkspaceOperation
      Set the resources which are affected by this operation
      Overrides:
      setTargetResources in class AbstractWorkspaceOperation
      Parameters:
      targetResources - an array of resources