01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.refactoring.api;
43:
44: import org.openide.util.Lookup;
45:
46: /**
47: * Refactoring to Safely Delete an element after checking its usages.
48: * @see org.netbeans.modules.refactoring.spi.RefactoringPlugin
49: * @see org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
50: * @see AbstractRefactoring
51: * @see RefactoringSession
52: * @author Bharath Ravikumar, Jan Becicka
53: */
54: public final class SafeDeleteRefactoring extends AbstractRefactoring {
55: private boolean checkInComments;
56:
57: /**
58: * Creates a new instance of SafeDeleteRefactoring, passing Lookup containing the candidate
59: * elements as parameter.
60: *
61: * Safe Delete Refactoring implementations currently understand following types:
62: * <table border="1">
63: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
64: * <tr><td>Refactoring API (Default impl.)</td><td>FileObject</td><td>Does file delete</td></tr>
65: * <tr><td>Java Refactoring</td><td><ul><li>{@link org.openide.filesystems.FileObject}(s) with content type text/x-java (safly delete class)
66: * <li>{@link org.netbeans.api.java.source.TreePathHandle} (class, field, method)</td>
67: * <td>Check for usages and does refactoring inside .java files.</td></tr>
68: * </table>
69: * @param namedElements The elements to be safely deleted
70: */
71: public SafeDeleteRefactoring(Lookup namedElements) {
72: super (namedElements);
73: }
74:
75: /**
76: * Indicates whether the usage of the elements will also be checked
77: * in comments before deleting the elements
78: * @return Returns the value of the field checkInComments
79: */
80: public boolean isCheckInComments() {
81: return checkInComments;
82: }
83:
84: /**
85: * Sets whether or not the usage of the elements will be checked
86: * in comments before deleting the elements
87: * @param checkInComments Sets the checInComments field of this class
88: */
89: public void setCheckInComments(boolean checkInComments) {
90: this.checkInComments = checkInComments;
91: }
92: }
|