org.netbeans.spi.project.MoveOperationImplementation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-projectapi Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.spi.project;

import java.io.File;
import java.io.IOException;
import org.netbeans.api.project.Project;

/**
 * Project Rename/Move Operation. Allows to gather information necessary for project
 * move and also provides callbacks to the project type to handle special
 * checkpoints during the delete.
 *
 * An implementation of this interface may be registered in the project's lookup to support
 * move operation in the following cases:
 * 
 *     The project type wants to use
 * DefaultProjectOperations
 *         to perform the rename/move operation.
 *    
 *    If this project may be part of of a compound project (like EJB project is a part of a J2EE project),
 *        and the compound project wants to rename/move all the sub-projects.
 *    
 * 
 *
 * The project type is not required to put an implementation of this interface into the project's
 * lookup if the above two cases should not be supported.
 *
 * Implementations are encouraged to implement {@link MoveOrRenameOperationImplementation} instead.
 *
 * @author Jan Lahoda
 * @since 1.7
 */
public interface MoveOperationImplementation extends DataFilesProviderImplementation {
    
    /**Pre-move notification. The exact meaning is left on the project implementors, but
     * typically this means to undeploy the application and remove all artifacts
     * created by the build project.
     *
     * @throws IOException if an I/O operation fails.
     * @see MoveOrRenameOperationImplementation#notifyRenaming
     */
    public void notifyMoving() throws IOException;
    
    /**Notification that the move operation has finished. Is supposed to fix the
     * newly created (moved) project into the correct state (including changing its display name
     * to nueName) and call {@link ProjectState#notifyDeleted} on the original project.
     * Should be called on both original and newly created project (in this order).
     *
     * @param original null when called on the original project, the original project when called on the new project
     * @param originalPath the project folder of the original project
     * @param nueName new name for the newly created project.
     *
     * @throws IOException if an I/O operation fails.
     * @see MoveOrRenameOperationImplementation#notifyRenamed
     */
    public void notifyMoved(Project original, File originalPath, String nueName) throws IOException;
    
}