SafeDeleteRefactoring (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.api
Class SafeDeleteRefactoring

java.lang.Object
  org.netbeans.modules.refactoring.api.AbstractRefactoring
      org.netbeans.modules.refactoring.api.SafeDeleteRefactoring

public final class SafeDeleteRefactoring
extends AbstractRefactoring
extends AbstractRefactoring

Refactoring to Safely Delete an element after checking its usages.

See Also:: RefactoringPlugin, RefactoringPluginFactory, AbstractRefactoring, RefactoringSession

Field Summary

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE

Constructor Summary

SafeDeleteRefactoring(Lookup namedElements)
          Creates a new instance of SafeDeleteRefactoring, passing Lookup containing the candidate elements as parameter.

Method Summary

boolean isCheckInComments()
          Indicates whether the usage of the elements will also be checked in comments before deleting the elements

void setCheckInComments(boolean checkInComments)
          Sets whether or not the usage of the elements will be checked in comments before deleting the elements

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener

Methods inherited from class java.lang.Object

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

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring
`INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE`

Constructor Summary
`SafeDeleteRefactoring(Lookup namedElements)` Creates a new instance of SafeDeleteRefactoring, passing Lookup containing the candidate elements as parameter.

Method Summary
`boolean`	`isCheckInComments()` Indicates whether the usage of the elements will also be checked in comments before deleting the elements
`void`	`setCheckInComments(boolean checkInComments)` Sets whether or not the usage of the elements will be checked in comments before deleting the elements

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring
`addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SafeDeleteRefactoring

public SafeDeleteRefactoring(Lookup namedElements)

Creates a new instance of SafeDeleteRefactoring, passing Lookup containing the candidate elements as parameter. Safe Delete Refactoring implementations currently understand following types:

Module	Types the Module Understands	Implementation
Refactoring API (Default impl.)	FileObject	Does file delete
Java Refactoring	`FileObject`(s) with content type text/x-java (safly delete class) `TreePathHandle` (class, field, method)	Check for usages and does refactoring inside .java files.

Parameters:: namedElements - The elements to be safely deleted

Method Detail

isCheckInComments

public boolean isCheckInComments()

Indicates whether the usage of the elements will also be checked in comments before deleting the elements

Returns:: Returns the value of the field checkInComments

setCheckInComments

public void setCheckInComments(boolean checkInComments)

Sets whether or not the usage of the elements will be checked in comments before deleting the elements

Parameters:: checkInComments - Sets the checInComments field of this class