Eclipse Plug-in Developer Guide (Galileo) - DeleteResourcesDescriptor (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ltk.core.refactoring.resource
Class DeleteResourcesDescriptor


java.lang.Object
  

org.eclipse.ltk.core.refactoring.RefactoringDescriptor
      
org.eclipse.ltk.core.refactoring.resource.DeleteResourcesDescriptor

All Implemented Interfaces:: Comparable

public class DeleteResourcesDescriptor
extends RefactoringDescriptor
extends RefactoringDescriptor

Refactoring descriptor for the delete resource refactoring.

An instance of this refactoring descriptor may be obtained by calling RefactoringContribution.createDescriptor() on a refactoring contribution requested by invoking RefactoringCore.getRefactoringContribution(String) with the refactoring id ( ID).

Note: this class is not intended to be subclassed or instantiated by clients.

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

Field Summary

static String ID
          Refactoring id of the 'Delete Resources' refactoring (value: org.eclipse.ltk.core.refactoring.delete.resources).

Fields inherited from class org.eclipse.ltk.core.refactoring. RefactoringDescriptor

BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE

Constructor Summary

DeleteResourcesDescriptor ()
          Creates a new refactoring descriptor.

Method Summary

Refactoring createRefactoring ( RefactoringStatus status)
          Creates the a new refactoring instance for this refactoring descriptor.

IPath[] getResourcePaths ()
          The resource paths to delete.

boolean isDeleteContents ()
          true is returned if projects contents are also deleted.

void setDeleteContents (boolean deleteContents)
          If set to true, delete will also delete project contents.

void setResourcePaths ( IPath[] resourcePath)
          The paths to the resources to be deleted.

void setResources ( IResource[] resources)
          The resources to be deleted.

Methods inherited from class org.eclipse.ltk.core.refactoring. RefactoringDescriptor

compareTo, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setComment, setDescription, setFlags, setProject, setTimeStamp, toString

Methods inherited from class java.lang. Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final 
String ID

Refactoring id of the 'Delete Resources' refactoring (value: org.eclipse.ltk.core.refactoring.delete.resources).

Clients may safely cast the obtained refactoring descriptor to DeleteResourcesDescriptor.

See Also:: Constant Field Values

Constructor Detail

DeleteResourcesDescriptor

public DeleteResourcesDescriptor()

Creates a new refactoring descriptor.

Clients should not instantiated this class but use RefactoringCore.getRefactoringContribution(String) with ID to get the contribution that can create the descriptor.

Method Detail

getResourcePaths

public 
IPath[] getResourcePaths()

The resource paths to delete.

Returns:: an array of IPaths.

setResourcePaths

public void setResourcePaths(
IPath[] resourcePath)

The paths to the resources to be deleted. The resources can be IProject or a mixture of IFile and IFolder.

Parameters:: resourcePath - paths of the resources to be deleted

setResources

public void setResources(
IResource[] resources)

The resources to be deleted. They can be IProject or a mixture of IFile and IFolder.

Parameters:: resources - IResources to be deleted

isDeleteContents

public boolean isDeleteContents()

true is returned if projects contents are also deleted.

Returns:: true if this will delete the project contents. The content delete is not undoable.

setDeleteContents

public void setDeleteContents(boolean deleteContents)

If set to true, delete will also delete project contents.

Parameters:: deleteContents - true if this will delete the project contents. The content delete is not undoable.

createRefactoring

public 
Refactoring createRefactoring(
RefactoringStatus status)
                              throws 
CoreException

Description copied from class: RefactoringDescriptor

Creates the a new refactoring instance for this refactoring descriptor.

This method is used by the refactoring framework to instantiate a refactoring from a refactoring descriptor, in order to apply it later on a local or remote workspace.

The returned refactoring must be in an initialized state, i.e. ready to be executed via PerformRefactoringOperation.

Specified by:: createRefactoring in class RefactoringDescriptor

Parameters:: status - a refactoring status used to describe the outcome of the initialization
Returns:: the refactoring, or null if this refactoring descriptor represents the unknown refactoring, or if no refactoring contribution is available for this refactoring descriptor which is capable to create a refactoring
Throws:: CoreException - if an error occurs while creating the refactoring instance