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: package org.netbeans.spi.project;
42:
43: import java.io.File;
44: import java.io.IOException;
45: import org.netbeans.api.project.Project;
46:
47: /**
48: * Project Copy Operation. Allows to gather information necessary for project
49: * copy and also provides callbacks to the project type to handle special
50: * checkpoints during the copy process.
51: *
52: * An implementation of this interface may be registered in the project's lookup to support
53: * copy operation in the following cases:
54: * <ul>
55: * <li>The project type wants to use
56: * <a href="@org-netbeans-modules-projectuiapi@/org/netbeans/spi/project/ui/support/DefaultProjectOperations.html"><code>DefaultProjectOperations</code></a>
57: * to perform the copy operation.
58: * </li>
59: * <li>If this project may be part of of a compound project (like EJB project is a part of a J2EE project),
60: * and the compound project wants to copy all the sub-projects.
61: * </li>
62: * </ul>
63: *
64: * The project type is not required to put an implementation of this interface into the project's
65: * lookup if the above two cases should not be supported.
66: *
67: * @author Jan Lahoda
68: * @since 1.7
69: */
70: public interface CopyOperationImplementation extends
71: DataFilesProviderImplementation {
72:
73: /**Pre-copy notification. The exact meaning is left on the project implementors, but
74: * typically this means to undeloy the application and remove all artifacts
75: * created by the build project.
76: *
77: * @throws IOException if an I/O operation fails.
78: */
79: public void notifyCopying() throws IOException;
80:
81: /**Notification that the copy operation has finished. Is supposed to fix the
82: * newly created (copied) project into the correct state (including changing its display name
83: * to nueName). Should be called on both original and newly created project (in this order).
84: *
85: * @param original <code>null</code> when called on the original project, the original project when called on the new project
86: * @param originalPath the project folder of the original project (for consistency
87: * with MoveOperationImplementation.notifyMoved)
88: * @param nueName new name for the newly created project.
89: *
90: * @throws IOException if an I/O operation fails.
91: */
92: public void notifyCopied(Project original, File originalPath,
93: String nueName) throws IOException;
94:
95: }
|