Attachment #23363 for bug #61546

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 61546
Collapse All | Expand All




    }

    /**
     * Create an action "Copy Project".
     * It should be invoked with an action context containing
     * one or more {@link org.netbeans.api.project.Project}s.
     * <p class="nonnormative">
     * You might include this in the context menu of a logical view.
     * </p>
     * @since 1.10
     * @return an action
     */
    public static Action copyProjectAction() {
        return Utilities.getActionsFactory().copyProjectAction();
    }
    
    /**
     * Create an action "Move Project".
     * It should be invoked with an action context containing
     * one or more {@link org.netbeans.api.project.Project}s.
     * <p class="nonnormative">
     * You might include this in the context menu of a logical view.
     * </p>
     * @since 1.10
     * @return an action
     */
    public static Action moveProjectAction() {
        return Utilities.getActionsFactory().moveProjectAction();
    }
    
    /**
     * Create an action "Rename Project".
     * It should be invoked with an action context containing
     * one or more {@link org.netbeans.api.project.Project}s.
     * <p class="nonnormative">
     * You might include this in the context menu of a logical view.
     * </p>
     * @since 1.10
     * @return an action
     */
    public static Action renameProjectAction() {
        return Utilities.getActionsFactory().renameProjectAction();
    }
    
    /**
     * Creates action that invokes <b>New Project</b> wizard.
     * 
     * <p>{@link #EXISTING_SOURCES_FOLDER} keyed action




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.spi.project.ui.support;

import org.netbeans.api.project.Project;
import org.netbeans.spi.project.support.ProjectOperations;
import org.netbeans.modules.project.uiapi.DefaultProjectOperationsImplementation;

/**Support class to allow the project type implementors to perform {@link ProjectOperations}
 * by simply calling a method in this class. Each method in this class provides a default
 * confirmation dialog and default behavior.
 *
 * If the project type requires a different behavior of an operation, it is required to provide its
 * own implementation of the operation.
 *
 * @since 1.10
 * @author Jan Lahoda
 */
public final class DefaultProjectOperations {
    
    /**
     * Creates a new instance of DefaultProjectOperations
     */
    private DefaultProjectOperations() {
    }
    
    /**Perform default delete operation. Gathers all necessary data, shows a confirmation
     * dialog and deletes the project (if confirmed by the user).
     *
     * @since 1.10
     *
     * @param p project to delete
     * @throws IllegalArgumentException if
     * <code>p == null</code> or
     * if {@link org.netbeans.api.projects.ProjectOperations.isDeleteOperationSupported}
     * returns false for this project.
     */
    public static void performDefaultDeleteOperation(Project p) throws IllegalArgumentException {
        if (p == null) {
            throw new IllegalArgumentException("Project is null");
        }
        
        if (!ProjectOperations.isDeleteOperationSupported(p)) {
            throw new IllegalStateException("Attempt to delete project that does not support deletion.");
        }
        
        DefaultProjectOperationsImplementation.deleteProject(p);
    }
    
    /**Perform default copy operation. Gathers all necessary data, shows a confirmation
     * dialog and copies the project (if confirmed by the user).
     *
     * @since 1.10
     *
     * @param p project to copy
     * @throws IllegalArgumentException if
     * <code>p == null</code> or
     * {@link org.netbeans.api.projects.ProjectOperations.isCopyOperationSupported}
     * returns false for this project.
     */
    public static void performDefaultCopyOperation(Project p) throws IllegalArgumentException {
        if (p == null) {
            throw new IllegalArgumentException("Project is null");
        }
        
        if (!ProjectOperations.isCopyOperationSupported(p)) {
            throw new IllegalStateException("Attempt to delete project that does not support copy.");
        }
        
        DefaultProjectOperationsImplementation.copyProject(p);
    }
    
    /**Perform default move operation. Gathers all necessary data, shows a confirmation
     * dialog and moves the project (if confirmed by the user).
     *
     * @since 1.10
     *
     * @param p project to move
     * @throws IllegalArgumentException if
     * <code>p == null</code> or
     * {@link org.netbeans.api.projects.ProjectOperations.ismoveOperationSupported}
     * returns false for this project.
     */
    public static void performDefaultMoveOperation(Project p) throws IllegalArgumentException {
        if (p == null) {
            throw new IllegalArgumentException("Project is null");
        }
        
        if (!ProjectOperations.isMoveOperationSupported(p)) {
            throw new IllegalStateException("Attempt to delete project that does not support move.");
        }
        
        DefaultProjectOperationsImplementation.moveProject(p);
    }
    
    /**Perform default rename operation. Gathers all necessary data, shows a confirmation
     * dialog and renames the project (if confirmed by the user).
     *
     * @since 1.10
     *
     * @param p project to move
     * @param newName new project's name or null
     * @throws IllegalArgumentException if
     * <code>p == null</code> or
     * {@link org.netbeans.api.projects.ProjectOperations.ismoveOperationSupported}
     * returns false for this project.
     */
    public static void performDefaultRenameOperation(Project p, String newName) throws IllegalStateException {
        if (p == null) {
            throw new IllegalArgumentException("Project is null");
        }
        
        if (!ProjectOperations.isMoveOperationSupported(p)) {
            throw new IllegalStateException("Attempt to delete project that does not support move.");
        }
        
        DefaultProjectOperationsImplementation.renameProject(p, newName);
    }
    
}




import org.netbeans.api.project.ProjectManager;
import org.netbeans.api.project.ant.AntArtifact;
import org.netbeans.modules.project.ant.AntBasedProjectFactorySingleton;
import org.netbeans.modules.project.ant.DefaultAntProjectOperations;
import org.netbeans.modules.project.ant.FileChangeSupport;
import org.netbeans.modules.project.ant.FileChangeSupportEvent;
import org.netbeans.modules.project.ant.FileChangeSupportListener;

import org.netbeans.spi.project.AuxiliaryConfiguration;
import org.netbeans.spi.project.CacheDirectoryProvider;
import org.netbeans.spi.project.ProjectState;
import org.netbeans.spi.project.support.ProjectOperations;
import org.netbeans.spi.queries.FileBuiltQueryImplementation;
import org.netbeans.spi.queries.SharabilityQueryImplementation;
import org.openide.ErrorManager;

        state.notifyDeleted();
    }
    
    /**Perform default delete operation. Gathers all necessary data, shows a confirmation
     * dialog and deletes the project (if confirmed by the user).
     *
     * @since 1.8
     *
     * @throws IllegalStateException if
     * {@link org.netbeans.api.projects.ProjectOperations.getDefault().isDeleteOperationSupported}
     * returns false for this project.
     */
    public void performDefaultDeleteOperation() throws IllegalStateException {
        Project p = AntBasedProjectFactorySingleton.getProjectFor(this);
        
        assert p != null;
        
        if (!ProjectOperations.getDefault().isDeleteOperationSupported(p)) {
            throw new IllegalStateException("Attempt to delete project that does not support deletion.");
        }
        
        DefaultAntProjectOperations.deleteProject(p);
    }
    
    /**
     * Mark this project as being modified without actually changing anything in it.




import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;

     */
    AntProjectHelper getAntProjectHelper() {
        return h;
    }
    
    /**Tries to fix references after copy/rename/move operation on the project.
     * Handles relative/absolute paths.
     *
     * @param originalPath the project folder of the original project
     * @see org.netbeans.spi.project.CopyOperationImplementation
     * @see org.netbeans.spi.project.MoveOperationImplementation
     * @since 1.9
     */
    public void fixReferences(File originalPath) {
        String[] prefixesToFix = new String[] {"file.reference.", "project."};
        EditableProperties pub  = h.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
        EditableProperties priv = h.getProperties(AntProjectHelper.PRIVATE_PROPERTIES_PATH);
        
        File projectDir = FileUtil.toFile(h.getProjectDirectory());
        
        List pubRemove = new ArrayList();
        List privRemove = new ArrayList();
        Map pubAdd = new HashMap();
        Map privAdd = new HashMap();
        
        for (Iterator i = pub.entrySet().iterator(); i.hasNext(); ) {
            Map.Entry e    = (Map.Entry) i.next();
            String    key  = (String) e.getKey();
            boolean   cont = false;
            
            for (int cntr = 0; cntr < prefixesToFix.length; cntr++) {
                if (key.startsWith(prefixesToFix[cntr])) {
                    cont = true;
                    break;
                }
            }
            if (!cont)
                continue;
            
            String    value = (String) e.getValue();
            
            File absolutePath = FileUtil.normalizeFile(PropertyUtils.resolveFile(originalPath, value));
            
            //TODO: extra base dir relativization:
            if (!CollocationQuery.areCollocated(absolutePath, projectDir)) {
                pubRemove.add(key);
                privAdd.put(key, absolutePath.getAbsolutePath());
            }
        }
        
        for (Iterator i = priv.entrySet().iterator(); i.hasNext(); ) {
            Map.Entry e    = (Map.Entry) i.next();
            String    key  = (String) e.getKey();
            boolean   cont = false;
            
            for (int cntr = 0; cntr < prefixesToFix.length; cntr++) {
                if (key.startsWith(prefixesToFix[cntr])) {
                    cont = true;
                    break;
                }
            }
            if (!cont)
                continue;
            
            String    value = (String) e.getValue();
            
            File absolutePath = FileUtil.normalizeFile(PropertyUtils.resolveFile(originalPath, value));
            
            //TODO: extra base dir relativization:
            if (CollocationQuery.areCollocated(absolutePath, projectDir)) {
                privRemove.add(key);
                pubAdd.put(key, PropertyUtils.relativizeFile(projectDir, absolutePath));
            }
        }
        
        for (Iterator i = pubRemove.iterator(); i.hasNext(); ) {
            pub.remove(i.next());
        }
        
        for (Iterator i = privRemove.iterator(); i.hasNext(); ) {
            priv.remove(i.next());
        }
        
        pub.putAll(pubAdd);
        priv.putAll(privAdd);
        
        h.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, pub);
        h.putProperties(AntProjectHelper.PRIVATE_PROPERTIES_PATH, priv);
    }
    
    /**





        <change id="delete-support">
            <api name="general"/>
            <summary>Basic Support SPI for Project Delete/Copy/Rename/Move</summary>
            <version major="1" minor="9"/>
            <date day="11" month="7" year="2005"/>
            <author login="jlahoda"/>
            <compatibility addition="yes"/>
            <description>
                Added <code>AntProjectHelper.notifyDeleted()</code>. Added <code>ReferenceHelper.fixReferences</code>.
                added.
            </description>
            <issue number="51468"/>
        </change>

Lines 1-5 Link Here

(-)ant/project/manifest.mf (-1 / +1 lines)
1	Manifest-Version: 1.0	1	Manifest-Version: 1.0
2	OpenIDE-Module: org.netbeans.modules.project.ant/1	2	OpenIDE-Module: org.netbeans.modules.project.ant/1
3	OpenIDE-Module-Specification-Version: 1.8	3	OpenIDE-Module-Specification-Version: 1.9
4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/project/ant/Bundle.properties	4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/project/ant/Bundle.properties
5		5





    <changes>

        <change id="copy-move-support">
            <api name="general"/>
            <summary>Added support for project delete/copy/rename/move</summary>
            <version major="1" minor="7"/>
            <date day="26" month="7" year="2005"/>
            <author login="jlahoda"/>
            <compatibility addition="true" binary="true" deletion="false" deprecation="false" modification="false" semantic="false" source="true">
                <p>
                    As only the ProjectManager is allowed to implement ProjectState interface,
                    this change should not directly affect any clients.
                </p>
            </compatibility>
            <description>
                <p>
                    Introduced:
                    <ul>
                        <li>
                            New method <code>notifyDeleted</code> added to <code>ProjectState</code>.
                        </li>
                        <li>
                            Interfaces DataFilesProviderImplementation, DeleteOperationImplementation, CopyOperationImplementation, MoveOperationImplementation has
                            been added to support project delete/copy/rename/move.
                        </li>
                        <li>
                            Support class ProjectOperations has been added to simplify operations on compound projects.
                        </li>
                    </ul>
                </p>
            </description>
            <issue number="TODO"/>
        </change>
        
        <change id="markExternal-for-file-and-URIs">

Lines 1-5 Link Here

(-)projects/projectapi/manifest.mf (-1 / +1 lines)
1	Manifest-Version: 1.0	1	Manifest-Version: 1.0
2	OpenIDE-Module: org.netbeans.modules.projectapi/1	2	OpenIDE-Module: org.netbeans.modules.projectapi/1
3	OpenIDE-Module-Specification-Version: 1.6	3	OpenIDE-Module-Specification-Version: 1.7
4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/projectapi/Bundle.properties	4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/projectapi/Bundle.properties
5		5




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.project;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import org.netbeans.spi.project.ProjectOperationsImplementation.DataFilesProviderImplementation;
import org.netbeans.spi.project.ProjectOperationsImplementation.DeleteOperationImplementation;
import org.openide.util.Lookup;

/**Allows gathering information for vaious project operations (currently only project delete, but will
 * be extended in the future).
 *
 * <p><b><font size=+1>Project Delete Operation</font></b>
 *
 * Consists of {@link #getMetadataFiles(Project) getMetadataFiles},
 * {@link #getDataFiles(Project) getDataFiles}, {@link #performClean(Project) performClean}
 * and {@link #notifyDeleted(Project) notifyDeleted}.
 *
 * The delete operation should run in two phases: preparation, when
 * {@link #getMetadataFiles(Project) getMetadataFiles} and {@link #getDataFiles(Project) getDataFiles}
 * (any number of times,
 * in any order) are called and performing, when {@link #performClean(Project) performClean} should be called,
 * then the files previously returned should be deleted (as required by the user)
 * and finally {@link #notifyDeleted(Project) notifyDeleted} should be called.
 *
 * @since  1.6
 * @author Jan Lahoda
 */
public final class ProjectOperations {
    
    private static ProjectOperations INSTANCE = null;
    
    public static synchronized ProjectOperations getDefault() {
        if (INSTANCE == null) {
            INSTANCE = new ProjectOperations();
        }
        
        return INSTANCE;
    }
    
    private ProjectOperations() {
    }
    
    /**Return list of files that are considered metadata files and folders for the given project.
     * Returns meaningfull values only if some of the <code>is*Supported</code> methods
     * return <code>true</code>.
     *
     * @param prj project to test
     * @return list of metadata files/folders
     */
    public List/*<FileObject>*/ getMetadataFiles(Project prj) {
        List/*<FileObject>*/ result = new ArrayList();
        
        for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
            result.addAll(((DataFilesProviderImplementation) i.next()).getMetadataFiles());
        }
        
        return result;
    }
            
    /**Return list of files that are considered source files and folders for the given project.
     * Returns meaningfull values only if some of the <code>is*Supported</code> methods
     * return <code>true</code>.
     *
     * @param prj project to test
     * @return list of data files/folders
     */
    public List/*<FileObject>*/ getDataFiles(Project prj) {
        List/*<FileObject>*/ result = new ArrayList();
        
        for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
            result.addAll(((DataFilesProviderImplementation) i.next()).getDataFiles());
        }
        
        return result;
    }
    
    /**Test whether the delete operation is supported on the given project.
     *
     * 
     * @param prj project to test
     * @return <code>true</code> if the project supports delete operation,
     *         <code>false</code> otherwise
     */
    public boolean isDeleteOperationSupported(Project prj) {
        return !getDeleteOperationImplementation(prj).isEmpty();
    }
    
    /**Performs pre-delete clean of the project. Should be called immediatelly before
     * the project is deleted.
     *
     * @param prj project to clean
     */
    public void performClean(Project prj) throws IOException {
        for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((DeleteOperationImplementation) i.next()).performClean();
        }
    }
    
    /**Post-delete notification that the project has been deleted.. Should be called immediatelly after
     * the project is deleted.
     *
     * @param prj deleted project
     */
    public void notifyDeleted(Project prj) throws IOException {
        for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((DeleteOperationImplementation) i.next()).notifyDeleted();
        }
    }
    
    private Collection/*<DeleteOperationImplementation>*/ getDeleteOperationImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(DeleteOperationImplementation.class)).allInstances();
    }
    
    private Collection/*<DataFilesProviderImplementation>*/ getProjectsOperationsImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(DataFilesProviderImplementation.class)).allInstances();
    }
    
}




    String COMMAND_DELETE = "delete"; // NOI18N
    
    /**
     * Standard command for deleting the project.
     *
     * @since 1.7
     */
    String COMMAND_COPY = "copy"; // NOI18N
    
    /**
     * Standard command for deleting the project.
     *
     * @since 1.7
     */
    String COMMAND_MOVE = "move"; // NOI18N

    /**
     * Standard command for deleting the project.
     *
     * @since 1.7
     */
    String COMMAND_RENAME = "rename"; // NOI18N
    
    /**
     * Get a list of all commands which this project supports.
     * @return a list of command names suitable for {@link #invokeAction}
     * @see #COMMAND_BUILD




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.spi.project;

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

/**
 * Project Copy Operation. Allows to gather information necessary for project
 * copy and also provides callbacks to the project type to handle special
 * checkpoints during the copy process.
 *
 * An implementation of this interface may be registered in the project's lookup to support
 * copy operation in the following cases:
 * <ul>
 *     <li>The project type wants to use the {@link org.netbeans.spi.project.ui.support DefaultProjectOperationsImplementation}
 *         to perform the copy operation.
 *    </li>
 *    <li>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 copy all the sub-projects.
 *    </li>
 * </ul>
 *
 * 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.
 *
 * @author Jan Lahoda
 * @since 1.7
 */
public interface CopyOperationImplementation extends DataFilesProviderImplementation {
    
    /**Pre-copy notification. The exact meaning is left on the project implementors, but
     * typically this means to undeloy the application and remove all artifacts
     * created by the build project.
     *
     * @throws IOException if an I/O operation fails.
     */
    public void notifyCopying() throws IOException;
    
    /**Notification that the copy operation has finished. Is supposed to fix the
     * newly created (copied) project into the correct state (including changing its display name
     * to nueName). Should be called on both original and newly created project (in this order).
     *
     * @param original the original project
     * @param originalPath the project folder of the original project (for consistency
     *                     with MoveOperationImplementation.notifyMoved)
     * @param nueName new name for the newly created project.
     *
     * @throws IOException if an I/O operation fails.
     */
    public void notifyCopied(Project original, File originalPath, String nueName)  throws IOException;
    
}




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.spi.project;

import java.util.List;
import org.openide.filesystems.FileObject;

/**
 * Base for various Project Operations, allows to gather metadata and data files
 * for a project.
 *
 * @author Jan Lahoda
 * @since 1.7
 */
public interface DataFilesProviderImplementation {
    
    /**
     * Returns list of {@link FileObject}s the are considered to be metadata files
     * and folders belonging into this project.
     * See {@link ProjectOperations#getMetadataFiles()} for more information.
     *
     * @return list of {@link FileObject}s that are considered metadata files and folders.
     */
    public List/*<FileObject>*/ getMetadataFiles();
    
    /**
     * Returns list of {@link FileObject}s the are considered to be data files and folders
     * belonging into this project.
     * See {@link ProjectOperations#getDataFiles()} for more information.
     *
     * @return list of {@link FileObject}s that are considered data files and folders.
     */
    public List/*<FileObject>*/ getDataFiles();
    
}




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.spi.project;

import java.io.IOException;

/**
 * Project Delete Operation. Allows to gather information necessary for project
 * delete 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
 * delete operation in the following cases:
 * <ul>
 *     <li>The project type wants to use the {@link org.netbeans.spi.project.ui.support.DefaultProjectOperationsImplementation}
 *         to perform the delete operation.
 *    </li>
 *    <li>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 delete all the sub-projects.
 *    </li>
 * </ul>
 *
 * 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.
 *
 * @author Jan Lahoda
 * @since 1.7
 */
public interface DeleteOperationImplementation extends DataFilesProviderImplementation {
    
    /**Pre-delete notification. The exact meaning is left on the project implementors, but
     * typically this means to undeloy the application and remove all artifacts
     * created by the build project.
     *
     * @throws IOException if an I/O operation fails.
     */
    public void notifyDeleting() throws IOException;
    
    /**Notification that the delete operation has finished. Is supposed to perform
     * final cleanup and to call {@link ProjectState#notifyDeleted}.
     *
     * @throws IOException if an I/O operation fails.
     */
    public void notifyDeleted() throws IOException;

}




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
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:
 * <ul>
 *     <li>The project type wants to use the {@link org.netbeans.spi.project.ui.support.DefaultProjectOperationsImplementation}
 *         to perform the rename/move operation.
 *    </li>
 *    <li>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.
 *    </li>
 * </ul>
 *
 * 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.
 *
 * @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 undeloy the application and remove all artifacts
     * created by the build project.
     *
     * @throws IOException if an I/O operation fails.
     */
    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 the original 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.
     */
    public void notifyMoved(Project original, File originalPath, String nueName) throws IOException;
    
}




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.project;

import java.io.IOException;
import java.util.List;
import org.netbeans.api.project.ProjectOperations;

/**This is only a scope class that holds several project operation interfaces.
 * See particular interface for more information:
 * <li>
 *     <ul>{@link DeleteOperationImplementation DeleteOperationImplementation}</ul>
 * </li>
 *
 * @since 1.6
 * @author Jan Lahoda
 */
public final class ProjectOperationsImplementation {
    
    /**
     * Base for various Project Operations, allows to gather metadata and data files
     * for a project.
     */
    public interface DataFilesProviderImplementation {
        
        /**
         * Returns list of {@link FileObject}s the are considered to be metadata files
         * and folders belonging into this project.
         * See {@link ProjectOperations#getMetadataFiles()} for more information.
         *
         * @return list of {@link FileObject}s that are considered metadata files and folders.
         */
        public List/*<FileObject>*/ getMetadataFiles();
        
        /**
         * Returns list of {@link FileObject}s the are considered to be data files and folders
         * belonging into this project.
         * See {@link ProjectOperations#getDataFiles()} for more information.
         *
         * @return list of {@link FileObject}s that are considered data files and folders.
         */
        public List/*<FileObject>*/ getDataFiles();
        
    }
    
    /**
     * Project Delete Operation. Allows to gather information necessary for project
     * delete and also provides callbacks to the project type to handle special
     * checkpoints during the delete.
     * 
     * An implementation of this interface should be registered in the project to support
     * delete operation.
     */
    public interface DeleteOperationImplementation extends DataFilesProviderImplementation {
        
        /**Pre-delete clean. The exact meaning is left on the project implementors, but
         * typically this means to undeloy the application and remove all artifacts
         * created by the build project.
         *
         * @throws IOException if an I/O operation fails.
         */
        public void performClean() throws IOException;
        
        /**Notification that the delete operation has finished. Is supposed to perform
         * final cleanup and to call {@link ProjectState#notifyDeleted}.
         *
         * @throws IOException if an I/O operation fails.
         */
        public void notifyDeleted() throws IOException;
        
    }
    
}




/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.project.support;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import org.netbeans.api.project.Project;
import org.netbeans.spi.project.CopyOperationImplementation;
import org.netbeans.spi.project.DataFilesProviderImplementation;
import org.netbeans.spi.project.DeleteOperationImplementation;
import org.netbeans.spi.project.MoveOperationImplementation;
import org.openide.util.Lookup;

/**
 * Allows gathering information for various project operations.
 * 
 * @author Jan Lahoda
 * @since 1.7
 */
public final class ProjectOperations {
    
    private ProjectOperations() {
    }
    
    /**Return list of files that are considered metadata files and folders for the given project.
     * Returns meaningfull values only if some of the <code>is*Supported</code> methods
     * return <code>true</code>.
     *
     * @param prj project to test
     * @return list of metadata files/folders
     */
    public static List/*<FileObject>*/ getMetadataFiles(Project prj) {
        List/*<FileObject>*/ result = new ArrayList();
        
        for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
            result.addAll(((DataFilesProviderImplementation) i.next()).getMetadataFiles());
        }
        
        return result;
    }
            
    /**Return list of files that are considered source files and folders for the given project.
     * Returns meaningfull values only if some of the <code>is*Supported</code> methods
     * return <code>true</code>.
     *
     * @param prj project to test
     * @return list of data files/folders
     */
    public static List/*<FileObject>*/ getDataFiles(Project prj) {
        List/*<FileObject>*/ result = new ArrayList();
        
        for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
            result.addAll(((DataFilesProviderImplementation) i.next()).getDataFiles());
        }
        
        return result;
    }
    
    /**Test whether the delete operation is supported on the given project.
     * 
     * @param prj project to test
     * @return <code>true</code> if the project supports delete operation,
     *         <code>false</code> otherwise
     */
    public static boolean isDeleteOperationSupported(Project prj) {
        return !getDeleteOperationImplementation(prj).isEmpty();
    }
    
    /**Notification that the project is about to be deleted.
     * Should be called immediatelly before the project is deleted.
     *
     * The project is supposed to do all required cleanup to allow the project to be deleted.
     *
     * @param prj project to notify
     * @throws IOException is some error occurs
     */
    public static void notifyDeleting(Project prj) throws IOException {
        for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((DeleteOperationImplementation) i.next()).notifyDeleting();
        }
    }
    
    /**Notification that the project has been deleted.
     * Should be called immediatelly after the project is deleted.
     *
     * @param prj project to notify
     * @throws IOException is some error occurs
     */
    public static void notifyDeleted(Project prj) throws IOException {
        for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((DeleteOperationImplementation) i.next()).notifyDeleted();
        }
    }
    
    /**Test whether the copy operation is supported on the given project.
     * 
     * @param prj project to test
     * @return <code>true</code> if the project supports the copy operation,
     *         <code>false</code> otherwise
     */
    public static boolean isCopyOperationSupported(Project prj) {
        return !getCopyOperationImplementation(prj).isEmpty();
    }
    
    /**Notification that the project is about to be copyied.
     * Should be called immediatelly before the project is copied.
     *
     * The project is supposed to do all required cleanup to allow the project to be copied.
     *
     * @param prj project to notify
     * @throws IOException is some error occurs
     */
    public static void notifyCopying(Project prj) throws IOException {
        for (Iterator i = getCopyOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((CopyOperationImplementation) i.next()).notifyCopying();
        }
    }
    
    /**Notification that the project has been copied.
     * Should be called immediatelly after the project is copied.
     *
     * The project is supposed to do all necessary fixes to the project's structure to
     * form a valid project.
     *
     * Both original and newly created project (copy) are notified, in this order.
     *
     * @param original original project
     * @param nue      new project (copy)
     * @param originalPath the project folder of the original project (for consistency with notifyMoved)
     * @param name     new name of the project
     * @throws IOException is some error occurs
     */
    public static void notifyCopied(Project original, Project nue, File originalPath, String name) throws IOException {
        for (Iterator i = getCopyOperationImplementation(original).iterator(); i.hasNext(); ) {
            ((CopyOperationImplementation) i.next()).notifyCopied(original, originalPath, name);
        }
        for (Iterator i = getCopyOperationImplementation(nue).iterator(); i.hasNext(); ) {
            ((CopyOperationImplementation) i.next()).notifyCopied(original, originalPath, name);
        }
    }
    
    /**Notification that the project is about to be moved.
     * Should be called immediatelly before the project is moved.
     *
     * The project is supposed to do all required cleanup to allow the project to be moved.
     *
     * @param prj project to notify
     * @throws IOException is some error occurs
     */
    public static void notifyMoving(Project prj) throws IOException {
        for (Iterator i = getMoveOperationImplementation(prj).iterator(); i.hasNext(); ) {
            ((MoveOperationImplementation) i.next()).notifyMoving();
        }
    }
    
    /**Notification that the project has been moved.
     * Should be called immediatelly after the project is moved.
     *
     * The project is supposed to do all necessary fixes to the project's structure to
     * form a valid project.
     *
     * Both original and moved project are notified, in this order.
     *
     * @param original original project
     * @param nue      moved project
     * @param originalPath the project folder of the original project
     * @param name     new name of the project
     * @throws IOException is some error occurs
     */
    public static void notifyMoved(Project original, Project nue, File originalPath, String name) throws IOException {
        for (Iterator i = getMoveOperationImplementation(original).iterator(); i.hasNext(); ) {
            ((MoveOperationImplementation) i.next()).notifyMoved(original, originalPath, name);
        }
        for (Iterator i = getMoveOperationImplementation(nue).iterator(); i.hasNext(); ) {
            ((MoveOperationImplementation) i.next()).notifyMoved(original, originalPath, name);
        }
    }
    
    /**Test whether the move operation is supported on the given project.
     * 
     * @param prj project to test
     * @return <code>true</code> if the project supports the move operation,
     *         <code>false</code> otherwise
     */
    public static boolean isMoveOperationSupported(Project prj) {
        return true;
    }
    
    private static Collection/*<DeleteOperationImplementation>*/ getDeleteOperationImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(DeleteOperationImplementation.class)).allInstances();
    }
    
    private static Collection/*<DataFilesProviderImplementation>*/ getProjectsOperationsImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(DataFilesProviderImplementation.class)).allInstances();
    }
    
    private static Collection/*<CopyOperationImplementation>*/ getCopyOperationImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(CopyOperationImplementation.class)).allInstances();
    }
    
    private static Collection/*<MoveOperationImplementation>*/ getMoveOperationImplementation(Project prj) {
        return prj.getLookup().lookup(new Lookup.Template(MoveOperationImplementation.class)).allInstances();
    }
    
}

Return to bug 61546

Lines 113-118 Link Here

(-)projects/projectuiapi/src/org/netbeans/spi/project/ui/support/CommonProjectActions.java (+42 lines)
113	}	113	}
114		114
115	/**	115	/**
		116	* Create an action "Copy Project".
		117	* It should be invoked with an action context containing
		118	* one or more {@link org.netbeans.api.project.Project}s.
		119	* <p class="nonnormative">
		120	* You might include this in the context menu of a logical view.
		121	* </p>
		122	* @since 1.10
		123	* @return an action
		124	*/
		125	public static Action copyProjectAction() {
		126	return Utilities.getActionsFactory().copyProjectAction();
		127	}
		128
		129	/**
		130	* Create an action "Move Project".
		131	* It should be invoked with an action context containing
		132	* one or more {@link org.netbeans.api.project.Project}s.
		133	* <p class="nonnormative">
		134	* You might include this in the context menu of a logical view.
		135	* </p>
		136	* @since 1.10
		137	* @return an action
		138	*/
		139	public static Action moveProjectAction() {
		140	return Utilities.getActionsFactory().moveProjectAction();
		141	}
		142
		143	/**
		144	* Create an action "Rename Project".
		145	* It should be invoked with an action context containing
		146	* one or more {@link org.netbeans.api.project.Project}s.
		147	* <p class="nonnormative">
		148	* You might include this in the context menu of a logical view.
		149	* </p>
		150	* @since 1.10
		151	* @return an action
		152	*/
		153	public static Action renameProjectAction() {
		154	return Utilities.getActionsFactory().renameProjectAction();
		155	}
		156
		157	/**
116	* Creates action that invokes <b>New Project</b> wizard.	158	* Creates action that invokes <b>New Project</b> wizard.
117	*	159	*
118	* <p>{@link #EXISTING_SOURCES_FOLDER} keyed action	160	* <p>{@link #EXISTING_SOURCES_FOLDER} keyed action

Lines 29-35 Link Here

(-)ant/project/src/org/netbeans/spi/project/support/ant/AntProjectHelper.java (-22 / +1 lines)
29	import org.netbeans.api.project.ProjectManager;	29	import org.netbeans.api.project.ProjectManager;
30	import org.netbeans.api.project.ant.AntArtifact;	30	import org.netbeans.api.project.ant.AntArtifact;
31	import org.netbeans.modules.project.ant.AntBasedProjectFactorySingleton;	31	import org.netbeans.modules.project.ant.AntBasedProjectFactorySingleton;
32	import org.netbeans.modules.project.ant.DefaultAntProjectOperations;
33	import org.netbeans.modules.project.ant.FileChangeSupport;	32	import org.netbeans.modules.project.ant.FileChangeSupport;
34	import org.netbeans.modules.project.ant.FileChangeSupportEvent;	33	import org.netbeans.modules.project.ant.FileChangeSupportEvent;
35	import org.netbeans.modules.project.ant.FileChangeSupportListener;	34	import org.netbeans.modules.project.ant.FileChangeSupportListener;
Lines 38-44 Link Here
38	import org.netbeans.spi.project.AuxiliaryConfiguration;	37	import org.netbeans.spi.project.AuxiliaryConfiguration;
39	import org.netbeans.spi.project.CacheDirectoryProvider;	38	import org.netbeans.spi.project.CacheDirectoryProvider;
40	import org.netbeans.spi.project.ProjectState;	39	import org.netbeans.spi.project.ProjectState;
41	import org.netbeans.api.project.ProjectOperations;	40	import org.netbeans.spi.project.support.ProjectOperations;
42	import org.netbeans.spi.queries.FileBuiltQueryImplementation;	41	import org.netbeans.spi.queries.FileBuiltQueryImplementation;
43	import org.netbeans.spi.queries.SharabilityQueryImplementation;	42	import org.netbeans.spi.queries.SharabilityQueryImplementation;
44	import org.openide.ErrorManager;	43	import org.openide.ErrorManager;
Lines 482-507 Link Here
482	state.notifyDeleted();	481	state.notifyDeleted();
483	}	482	}
484		483
485	/**Perform default delete operation. Gathers all necessary data, shows a confirmation
486	* dialog and deletes the project (if confirmed by the user).
487	*
488	* @since 1.8
489	*
490	* @throws IllegalStateException if
491	* {@link org.netbeans.api.projects.ProjectOperations.getDefault().isDeleteOperationSupported}
492	* returns false for this project.
493	*/
494	public void performDefaultDeleteOperation() throws IllegalStateException {
495	Project p = AntBasedProjectFactorySingleton.getProjectFor(this);
496
497	assert p != null;
498
499	if (!ProjectOperations.getDefault().isDeleteOperationSupported(p)) {
500	throw new IllegalStateException("Attempt to delete project that does not support deletion.");
501	}
502
503	DefaultAntProjectOperations.deleteProject(p);
504	}
505		484
506	/**	485	/**
507	* Mark this project as being modified without actually changing anything in it.	486	* Mark this project as being modified without actually changing anything in it.

Lines 19-25 Link Here

(-)ant/project/src/org/netbeans/spi/project/support/ant/ReferenceHelper.java (+87 lines)
19	import java.net.URISyntaxException;	19	import java.net.URISyntaxException;
20	import java.util.ArrayList;	20	import java.util.ArrayList;
21	import java.util.Arrays;	21	import java.util.Arrays;
		22	import java.util.Collection;
22	import java.util.Collections;	23	import java.util.Collections;
		24	import java.util.HashMap;
23	import java.util.HashSet;	25	import java.util.HashSet;
24	import java.util.Iterator;	26	import java.util.Iterator;
25	import java.util.List;	27	import java.util.List;
Lines 1229-1234 Link Here
1229	*/	1231	*/
1230	AntProjectHelper getAntProjectHelper() {	1232	AntProjectHelper getAntProjectHelper() {
1231	return h;	1233	return h;
		1234	}
		1235
		1236	/**Tries to fix references after copy/rename/move operation on the project.
		1237	* Handles relative/absolute paths.
		1238	*
		1239	* @param originalPath the project folder of the original project
		1240	* @see org.netbeans.spi.project.CopyOperationImplementation
		1241	* @see org.netbeans.spi.project.MoveOperationImplementation
		1242	* @since 1.9
		1243	*/
		1244	public void fixReferences(File originalPath) {
		1245	String[] prefixesToFix = new String[] {"file.reference.", "project."};
		1246	EditableProperties pub = h.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
		1247	EditableProperties priv = h.getProperties(AntProjectHelper.PRIVATE_PROPERTIES_PATH);
		1248
		1249	File projectDir = FileUtil.toFile(h.getProjectDirectory());
		1250
		1251	List pubRemove = new ArrayList();
		1252	List privRemove = new ArrayList();
		1253	Map pubAdd = new HashMap();
		1254	Map privAdd = new HashMap();
		1255
		1256	for (Iterator i = pub.entrySet().iterator(); i.hasNext(); ) {
		1257	Map.Entry e = (Map.Entry) i.next();
		1258	String key = (String) e.getKey();
		1259	boolean cont = false;
		1260
		1261	for (int cntr = 0; cntr < prefixesToFix.length; cntr++) {
		1262	if (key.startsWith(prefixesToFix[cntr])) {
		1263	cont = true;
		1264	break;
		1265	}
		1266	}
		1267	if (!cont)
		1268	continue;
		1269
		1270	String value = (String) e.getValue();
		1271
		1272	File absolutePath = FileUtil.normalizeFile(PropertyUtils.resolveFile(originalPath, value));
		1273
		1274	//TODO: extra base dir relativization:
		1275	if (!CollocationQuery.areCollocated(absolutePath, projectDir)) {
		1276	pubRemove.add(key);
		1277	privAdd.put(key, absolutePath.getAbsolutePath());
		1278	}
		1279	}
		1280
		1281	for (Iterator i = priv.entrySet().iterator(); i.hasNext(); ) {
		1282	Map.Entry e = (Map.Entry) i.next();
		1283	String key = (String) e.getKey();
		1284	boolean cont = false;
		1285
		1286	for (int cntr = 0; cntr < prefixesToFix.length; cntr++) {
		1287	if (key.startsWith(prefixesToFix[cntr])) {
		1288	cont = true;
		1289	break;
		1290	}
		1291	}
		1292	if (!cont)
		1293	continue;
		1294
		1295	String value = (String) e.getValue();
		1296
		1297	File absolutePath = FileUtil.normalizeFile(PropertyUtils.resolveFile(originalPath, value));
1298
1299	//TODO: extra base dir relativization:
1300	if (CollocationQuery.areCollocated(absolutePath, projectDir)) {
1301	privRemove.add(key);
1302	pubAdd.put(key, PropertyUtils.relativizeFile(projectDir, absolutePath));
1303	}
1304	}
1305
1306	for (Iterator i = pubRemove.iterator(); i.hasNext(); ) {
1307	pub.remove(i.next());
1308	}
1309
1310	for (Iterator i = privRemove.iterator(); i.hasNext(); ) {
1311	priv.remove(i.next());
1312	}
1313
1314	pub.putAll(pubAdd);
1315	priv.putAll(privAdd);
1316
1317	h.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, pub);
1318	h.putProperties(AntProjectHelper.PRIVATE_PROPERTIES_PATH, priv);
1232	}	1319	}
1233		1320
1234	/**	1321	/**

Lines 78-91 Link Here

(-)ant/project/apichanges.xml (-4 / +3 lines)
78		78
79	<change id="delete-support">	79	<change id="delete-support">
80	<api name="general"/>	80	<api name="general"/>
81	<summary>Basic Support SPI for Project Delete</summary>	81	<summary>Basic Support SPI for Project Delete/Copy/Rename/Move</summary>
82	<version major="1" minor="8"/>	82	<version major="1" minor="9"/>
83	<date day="11" month="7" year="2005"/>	83	<date day="11" month="7" year="2005"/>
84	<author login="jlahoda"/>	84	<author login="jlahoda"/>
85	<compatibility addition="yes"/>	85	<compatibility addition="yes"/>
86	<description>	86	<description>
87	<code>AntProjectHelper.notifyDeleted()</code> and <code>AntProjectHelper.performDefaultDeleteOperation()</code>	87	Added <code>AntProjectHelper.notifyDeleted()</code>. Added <code>ReferenceHelper.fixReferences</code>.
88	added.
89	</description>	88	</description>
90	<issue number="51468"/>	89	<issue number="51468"/>
91	</change>	90	</change>

Lines 76-106 Link Here

(-)projects/projectapi/apichanges.xml (-18 / +19 lines)
76		76
77	<changes>	77	<changes>
78		78
79	<change id="delete-support">	79	<change id="copy-move-support">
80	<api name="general"/>	80	<api name="general"/>
81	<summary>Support for project delete</summary>	81	<summary>Added support for project delete/copy/rename/move</summary>
82	<version major="1" minor="6"/>	82	<version major="1" minor="7"/>
83	<date day="11" month="7" year="2005"/>	83	<date day="26" month="7" year="2005"/>
84	<author login="jlahoda"/>	84	<author login="jlahoda"/>
85	<compatibility>	85	<compatibility addition="true" binary="true" deletion="false" deprecation="false" modification="false" semantic="false" source="true">
86	<p>
87	As only the ProjectManager is allowed to implement ProjectState interface,
88	this change should not directly affect any clients.
89	</p>
90	</compatibility>	86	</compatibility>
91	<description>	87	<description>
92	<p>	88	<p>
93	The <code>notifyDeleted</code> action is added to the <code>ProjectState</code>,	89	Introduced:
94	allowing the project implmentation to let the <code>ProjectManager</code>	90	<ul>
95	know that the project has been deleted. <code>ProjectManager.isValid(Project)</code> added	91	<li>
96	to detect deleted projects.	92	New method <code>notifyDeleted</code> added to <code>ProjectState</code>.
97	</p>	93	</li>
98	<p>	94	<li>
99	<code>ProjectOperations</code> and <code>ProjectOperationsImplementation</code> added to support	95	Interfaces DataFilesProviderImplementation, DeleteOperationImplementation, CopyOperationImplementation, MoveOperationImplementation has
100	project delete operation.	96	been added to support project delete/copy/rename/move.
		97	</li>
		98	<li>
		99	Support class ProjectOperations has been added to simplify operations on compound projects.
		100	</li>
		101	</ul>
101	</p>	102	</p>
102	</description>	103	</description>
103	<issue number="51468"/>	104	<issue number="TODO"/>
104	</change>	105	</change>
105		106
106	<change id="markExternal-for-file-and-URIs">	107	<change id="markExternal-for-file-and-URIs">

Added Link Here

(-)projects/projectuiapi/src/org/netbeans/spi/project/ui/support/DefaultProjectOperations.java (+130 lines)
1	/*
2	* Sun Public License Notice
3	*
4	* The contents of this file are subject to the Sun Public License
5	* Version 1.0 (the "License"). You may not use this file except in
6	* compliance with the License. A copy of the License is available at
7	* http://www.sun.com/
8	*
9	* The Original Code is NetBeans. The Initial Developer of the Original
10	* Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
11	* Microsystems, Inc. All Rights Reserved.
12	*/
13	package org.netbeans.spi.project.ui.support;
14
15	import org.netbeans.api.project.Project;
16	import org.netbeans.spi.project.support.ProjectOperations;
17	import org.netbeans.modules.project.uiapi.DefaultProjectOperationsImplementation;
18
19	/**Support class to allow the project type implementors to perform {@link ProjectOperations}
20	* by simply calling a method in this class. Each method in this class provides a default
21	* confirmation dialog and default behavior.
22	*
23	* If the project type requires a different behavior of an operation, it is required to provide its
24	* own implementation of the operation.
25	*
26	* @since 1.10
27	* @author Jan Lahoda
28	*/
29	public final class DefaultProjectOperations {
30
31	/**
32	* Creates a new instance of DefaultProjectOperations
33	*/
34	private DefaultProjectOperations() {
35	}
36
37	/**Perform default delete operation. Gathers all necessary data, shows a confirmation
38	* dialog and deletes the project (if confirmed by the user).
39	*
40	* @since 1.10
41	*
42	* @param p project to delete
43	* @throws IllegalArgumentException if
44	* <code>p == null</code> or
45	* if {@link org.netbeans.api.projects.ProjectOperations.isDeleteOperationSupported}
46	* returns false for this project.
47	*/
48	public static void performDefaultDeleteOperation(Project p) throws IllegalArgumentException {
49	if (p == null) {
50	throw new IllegalArgumentException("Project is null");
51	}
52
53	if (!ProjectOperations.isDeleteOperationSupported(p)) {
54	throw new IllegalStateException("Attempt to delete project that does not support deletion.");
55	}
56
57	DefaultProjectOperationsImplementation.deleteProject(p);
58	}
59
60	/**Perform default copy operation. Gathers all necessary data, shows a confirmation
61	* dialog and copies the project (if confirmed by the user).
62	*
63	* @since 1.10
64	*
65	* @param p project to copy
66	* @throws IllegalArgumentException if
67	* <code>p == null</code> or
68	* {@link org.netbeans.api.projects.ProjectOperations.isCopyOperationSupported}
69	* returns false for this project.
70	*/
71	public static void performDefaultCopyOperation(Project p) throws IllegalArgumentException {
72	if (p == null) {
73	throw new IllegalArgumentException("Project is null");
74	}
75
76	if (!ProjectOperations.isCopyOperationSupported(p)) {
77	throw new IllegalStateException("Attempt to delete project that does not support copy.");
78	}
79
80	DefaultProjectOperationsImplementation.copyProject(p);
81	}
82
83	/**Perform default move operation. Gathers all necessary data, shows a confirmation
84	* dialog and moves the project (if confirmed by the user).
85	*
86	* @since 1.10
87	*
88	* @param p project to move
89	* @throws IllegalArgumentException if
90	* <code>p == null</code> or
91	* {@link org.netbeans.api.projects.ProjectOperations.ismoveOperationSupported}
92	* returns false for this project.
93	*/
94	public static void performDefaultMoveOperation(Project p) throws IllegalArgumentException {
95	if (p == null) {
96	throw new IllegalArgumentException("Project is null");
97	}
98
99	if (!ProjectOperations.isMoveOperationSupported(p)) {
100	throw new IllegalStateException("Attempt to delete project that does not support move.");
101	}
102
103	DefaultProjectOperationsImplementation.moveProject(p);
104	}
105
106	/**Perform default rename operation. Gathers all necessary data, shows a confirmation
107	* dialog and renames the project (if confirmed by the user).
108	*
109	* @since 1.10
110	*
111	* @param p project to move
112	* @param newName new project's name or null
113	* @throws IllegalArgumentException if
114	* <code>p == null</code> or
115	* {@link org.netbeans.api.projects.ProjectOperations.ismoveOperationSupported}
116	* returns false for this project.
117	*/
118	public static void performDefaultRenameOperation(Project p, String newName) throws IllegalStateException {
119	if (p == null) {
120	throw new IllegalArgumentException("Project is null");
121	}
122
123	if (!ProjectOperations.isMoveOperationSupported(p)) {
124	throw new IllegalStateException("Attempt to delete project that does not support move.");
125	}
126
127	DefaultProjectOperationsImplementation.renameProject(p, newName);
128	}
129
130	}

Removed Link Here

(-)projects/projectapi/src/org/netbeans/api/project/ProjectOperations.java (-134 lines)
1	/*
2	* Sun Public License Notice
3	*
4	* The contents of this file are subject to the Sun Public License
5	* Version 1.0 (the "License"). You may not use this file except in
6	* compliance with the License. A copy of the License is available at
7	* http://www.sun.com/
8	*
9	* The Original Code is NetBeans. The Initial Developer of the Original
10	* Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun
11	* Microsystems, Inc. All Rights Reserved.
12	*/
13
14	package org.netbeans.api.project;
15
16	import java.io.IOException;
17	import java.util.ArrayList;
18	import java.util.Collection;
19	import java.util.Iterator;
20	import java.util.List;
21	import org.netbeans.spi.project.ProjectOperationsImplementation.DataFilesProviderImplementation;
22	import org.netbeans.spi.project.ProjectOperationsImplementation.DeleteOperationImplementation;
23	import org.openide.util.Lookup;
24
25	/**Allows gathering information for vaious project operations (currently only project delete, but will
26	* be extended in the future).
27	*
28	* <p><b><font size=+1>Project Delete Operation</font></b>
29	*
30	* Consists of {@link #getMetadataFiles(Project) getMetadataFiles},
31	* {@link #getDataFiles(Project) getDataFiles}, {@link #performClean(Project) performClean}
32	* and {@link #notifyDeleted(Project) notifyDeleted}.
33	*
34	* The delete operation should run in two phases: preparation, when
35	* {@link #getMetadataFiles(Project) getMetadataFiles} and {@link #getDataFiles(Project) getDataFiles}
36	* (any number of times,
37	* in any order) are called and performing, when {@link #performClean(Project) performClean} should be called,
38	* then the files previously returned should be deleted (as required by the user)
39	* and finally {@link #notifyDeleted(Project) notifyDeleted} should be called.
40	*
41	* @since 1.6
42	* @author Jan Lahoda
43	*/
44	public final class ProjectOperations {
45
46	private static ProjectOperations INSTANCE = null;
47
48	public static synchronized ProjectOperations getDefault() {
49	if (INSTANCE == null) {
50	INSTANCE = new ProjectOperations();
51	}
52
53	return INSTANCE;
54	}
55
56	private ProjectOperations() {
57	}
58
59	/**Return list of files that are considered metadata files and folders for the given project.
60	* Returns meaningfull values only if some of the <code>is*Supported</code> methods
61	* return <code>true</code>.
62	*
63	* @param prj project to test
64	* @return list of metadata files/folders
65	*/
66	public List/<FileObject>/ getMetadataFiles(Project prj) {
67	List/<FileObject>/ result = new ArrayList();
68
69	for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
70	result.addAll(((DataFilesProviderImplementation) i.next()).getMetadataFiles());
71	}
72
73	return result;
74	}
75
76	/**Return list of files that are considered source files and folders for the given project.
77	* Returns meaningfull values only if some of the <code>is*Supported</code> methods
78	* return <code>true</code>.
79	*
80	* @param prj project to test
81	* @return list of data files/folders
82	*/
83	public List/<FileObject>/ getDataFiles(Project prj) {
84	List/<FileObject>/ result = new ArrayList();
85
86	for (Iterator i = getProjectsOperationsImplementation(prj).iterator(); i.hasNext(); ) {
87	result.addAll(((DataFilesProviderImplementation) i.next()).getDataFiles());
88	}
89
90	return result;
91	}
92
93	/**Test whether the delete operation is supported on the given project.
94	*
95	*
96	* @param prj project to test
97	* @return <code>true</code> if the project supports delete operation,
98	* <code>false</code> otherwise
99	*/
100	public boolean isDeleteOperationSupported(Project prj) {
101	return !getDeleteOperationImplementation(prj).isEmpty();
102	}
103
104	/**Performs pre-delete clean of the project. Should be called immediatelly before
105	* the project is deleted.
106	*
107	* @param prj project to clean
108	*/
109	public void performClean(Project prj) throws IOException {
110	for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
111	((DeleteOperationImplementation) i.next()).performClean();
112	}
113	}
114
115	/**Post-delete notification that the project has been deleted.. Should be called immediatelly after
116	* the project is deleted.
117	*
118	* @param prj deleted project
119	*/
120	public void notifyDeleted(Project prj) throws IOException {
121	for (Iterator i = getDeleteOperationImplementation(prj).iterator(); i.hasNext(); ) {
122	((DeleteOperationImplementation) i.next()).notifyDeleted();
123	}
124	}
125
126	private Collection/<DeleteOperationImplementation>/ getDeleteOperationImplementation(Project prj) {
127	return prj.getLookup().lookup(new Lookup.Template(DeleteOperationImplementation.class)).allInstances();
128	}
129
130	private Collection/<DataFilesProviderImplementation>/ getProjectsOperationsImplementation(Project prj) {
131	return prj.getLookup().lookup(new Lookup.Template(DataFilesProviderImplementation.class)).allInstances();
132	}
133
134	}

Lines 94-99 Link Here

(-)projects/projectapi/src/org/netbeans/spi/project/ActionProvider.java (+21 lines)
94	String COMMAND_DELETE = "delete"; // NOI18N	94	String COMMAND_DELETE = "delete"; // NOI18N
95		95
96	/**	96	/**
		97	* Standard command for deleting the project.
		98	*
		99	* @since 1.7
		100	*/
		101	String COMMAND_COPY = "copy"; // NOI18N
		102
		103	/**
		104	* Standard command for deleting the project.
		105	*
		106	* @since 1.7
		107	*/
		108	String COMMAND_MOVE = "move"; // NOI18N
		109
		110	/**
		111	* Standard command for deleting the project.
		112	*
		113	* @since 1.7
		114	*/
		115	String COMMAND_RENAME = "rename"; // NOI18N
		116
		117	/**
97	* Get a list of all commands which this project supports.	118	* Get a list of all commands which this project supports.
98	* @return a list of command names suitable for {@link #invokeAction}	119	* @return a list of command names suitable for {@link #invokeAction}
99	* @see #COMMAND_BUILD	120	* @see #COMMAND_BUILD