001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.refactoring.api;
042:
043: import org.openide.util.Lookup;
044:
045: /**
046: * Refactoring used for renaming objects.
047: * @see org.netbeans.modules.refactoring.spi.RefactoringPlugin
048: * @see org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
049: * @see AbstractRefactoring
050: * @see RefactoringSession
051: * @author Jan Becicka, Martin Matula, Pavel Flaska, Daniel Prusa
052: */
053: public final class RenameRefactoring extends AbstractRefactoring {
054: private String newName = null;
055: private boolean searchInComments;
056:
057: /**
058: * Creates a new instance of RenameRefactoring.
059: * Rename Refactoring implementations currently understand following types:
060: * <table border="1">
061: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
062: * <tr><td>Refactoring API (Default impl.)</td><td>FileObject</td><td>Does file rename</td></tr>
063: * <tr><td>Java Refactoring</td><td><ul>
064: * <li>{@link org.openide.filesystems.FileObject}(s) with content type text/x-java (class rename)
065: * <li>{@link org.openide.filesystems.FileObject} (folder) folder rename
066: * <li>{@link org.netbeans.api.java.source.TreePathHandle} (class, field, method rename)
067: * <li>{@link org.netbeans.api.fileinfo.NonRecursiveFolder} package rename</td>
068: * </ul>
069: * <td>Does refactoring inside .java files.
070: * In case of FolderRename it also does corresponding file moves</td></tr>
071: * </table>
072: * @param item put object to rename into Lookup instance.
073: */
074: public RenameRefactoring(Lookup item) {
075: super (item);
076: }
077:
078: /**
079: * Getter for property newName
080: * @return Value of property newName
081: */
082: public String getNewName() {
083: return newName;
084: }
085:
086: /**
087: * Setter for propety newName
088: * @param newName New value of property newName
089: */
090: public void setNewName(String newName) {
091: this .newName = newName;
092: }
093:
094: /**
095: * Getter for boolean property searchInComments
096: * @return true if user selected search in comments
097: */
098: public boolean isSearchInComments() {
099: return searchInComments;
100: }
101:
102: /**
103: * Setter for property searchInComments.
104: * @param searchInComments New value of property searchInComments
105: */
106: public void setSearchInComments(boolean searchInComments) {
107: this.searchInComments = searchInComments;
108: }
109: }
|