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:
042: package org.netbeans.modules.refactoring.api;
043:
044: import org.openide.util.Lookup;
045:
046: /**
047: * This class is just holder for parameters of Single Copy Refactoring.
048: * Refactoring itself is implemented in plugins
049: * @see org.netbeans.modules.refactoring.spi.RefactoringPlugin
050: * @see org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
051: * @see AbstractRefactoring
052: * @see RefactoringSession
053: * @author Jan Becicka
054: */
055: public final class SingleCopyRefactoring extends AbstractRefactoring {
056:
057: private Lookup target;
058: private String newName;
059:
060: /**
061: * Creates a new instance of SingleCopyRefactoring.
062: * Single Copy Refactoring implementations currently understand following types:
063: * <table border="1">
064: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
065: * <tr><td>Refactoring API (Default impl.)</td><td>FileObject</td><td>Does file copy</td></tr>
066: * <tr><td>Java Refactoring</td><td><ul>
067: * <li>{@link FileObject}(s) with content type text/x-java (class copy)
068: * </ul>
069: * <td>Updates name, package declaration and import statements</td></tr>
070: * </table>
071: * @param objectToCopy Object to be copied stored into Lookup
072: */
073: public SingleCopyRefactoring(Lookup objectToCopy) {
074: super (objectToCopy);
075: }
076:
077: /**
078: * Target for copying.
079: * Single Copy Refactoring implementations currently understand following types:
080: * <table border="1">
081: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
082: * <tr><td>Refactoring API (Default impl.)</td><td>{@link java.net.URL}</td>
083: * <td>Creates directory corresponding to specified URL (if does not
084: * exist) and copies all FileObjects into this folder.</td></tr>
085: * <tr><td>Java Refactoring</td><td>{@link java.net.URL}</td><td>Updates name, package declaration and import statements</td></tr>
086: * </table>
087: * @param target
088: */
089: public void setTarget(Lookup target) {
090: this .target = target;
091: }
092:
093: /**
094: * Target for copying
095: * @see #setTarget
096: * @return target
097: */
098: public Lookup getTarget() {
099: return target;
100: }
101:
102: /**
103: * getter for new name of copied file
104: * @return value String value
105: */
106: public String getNewName() {
107: return newName;
108: }
109:
110: /**
111: * setter for new name of copied file
112: * @param newName new value
113: */
114: public void setNewName(String newName) {
115: this.newName = newName;
116: }
117: }
|