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: * This class is just holder for parameters of Move Refactoring.
48: * Refactoring itself is implemented in plugins.
49: *
50: * @see org.netbeans.modules.refactoring.spi.RefactoringPlugin
51: * @see org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
52: * @see AbstractRefactoring
53: * @see RefactoringSession
54: * @author Jan Becicka
55: */
56: public final class MoveRefactoring extends AbstractRefactoring {
57:
58: private Lookup target;
59:
60: /**
61: * Public constructor takes Lookup containing objects to refactor as parameter.
62: * Move Refactoring implementations currently understand following types:
63: * <table border="1">
64: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
65: * <tr><td>Refactoring API (Default impl.)</td><td>{@link org.openide.filsuystems.FileObject}(s)</td><td>Does file(s) move</td></tr>
66: * <tr><td>Java Refactoring</td><td>{@link org.openide.filsuystems.FileObject}(s) with content type text/x-java</td><td>Does refactoring inside .java files</td></tr>
67: * </table>
68: * @param objectsToMove store your objects into Lookup
69: */
70: public MoveRefactoring(Lookup objectsToMove) {
71: super (objectsToMove);
72: }
73:
74: /**
75: * Target for moving.
76: * Move Refactoring implementations currently understand following types:
77: * <table border="1">
78: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
79: * <tr><td>Refactoring API (Default impl.)</td><td>{@link java.net.URL}</td>
80: * <td>Creates direstory corresponding to specified {@link java.net.URL} if does not
81: * exist and moves all FileObjects into this folder.</td></tr>
82: * <tr><td>Java Refactoring</td><td>{@link java.net.URL}</td><td>Does move refactoring inside .java files</td></tr>
83: * </table>
84: * @param target
85: */
86: public void setTarget(Lookup target) {
87: this .target = target;
88: }
89:
90: /**
91: * Target for moving
92: * @see #setTarget
93: * @return target
94: */
95: public Lookup getTarget() {
96: return this.target;
97: }
98: }
|