/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2008 Sun Microsystems, Inc.
 */
package org.openide.util.actions;

import java.awt.Image;
import java.util.Collection;
import org.openide.nodes.Node;
import org.openide.util.ContextAction.LookupProviderAction;
import org.openide.util.RequestProcessor;

/**
 * Context action which operates on one or more nodes.
 * API-Compatible replacement for deprecated NodeAction.  Changes generally
 * needed to migrate an action:
 * <ul>
 * <li>Go through your source code and make sure there are @Override
 * annotations on all overriding methods.  That will make sure you don't
 * think you're overriding something you aren't once you change the superclass.</li>
 * <li>Replace superclass with NodeContextAction.
 * </li>
 * <li>Replace overrides of getName() with <code>putValue(NAME, displayName)</code>.</li>
 * <li>Delete any calls to setEnabled() (it will now throw an exception) 
 * and override <code>isEnabled()</code> as needed</li>
 * </ul>
 *
 * @author Tim Boudreau
 */
public abstract class NodeContextAction<R> extends LookupProviderAction<Node, R> {

    private boolean asynchronous;

    protected NodeContextAction(Class<R> type) {
        this(type, false);
    }

    protected NodeContextAction(Class<R> type, boolean asynchronous) {
        super(Node.class, type, false);
        this.asynchronous = asynchronous;
    }

    protected NodeContextAction(Class<R> type, boolean asynchronous, boolean all) {
        super(Node.class, type, all);
        this.asynchronous = asynchronous;
    }

    protected NodeContextAction(Class<R> type, boolean asynchronous, boolean all, String displayName, Image icon) {
        super(Node.class, type, all, displayName, icon);
        this.asynchronous = asynchronous;
    }

    protected final void perform(Collection<? extends R> targets) {
        final Node[] nodes = targets.toArray(new Node[targets.size()]);
        if (asynchronous) {
            RequestProcessor.getDefault().post(new Runner(this, nodes));
        } else {
            performAction(nodes);
        }
    }

    @Override
    protected final boolean isEnabled(Collection<? extends R> targets) {
        final Node[] nodes = targets.toArray(new Node[targets.size()]);
        return enable(nodes);
    }

    protected abstract boolean enable(Node[] activatedNodes);

    protected abstract void performAction(Node[] activatedNodes);

    private static class Runner implements Runnable {

        private final Node[] nodes;
        private final NodeContextAction action;

        Runner(NodeContextAction action, Node[] nodes) {
            this.action = action;
            assert action != null;
            this.nodes = nodes;
            assert nodes != null;
        }

        public void run() {
            action.performAction(nodes);
        }
    }
}