core/plugins/org.eclipse.dltk.ui/src corext/org/eclipse/dltk/internal/corext/buildpath/BuildpathModifierOperation.java

/*******************************************************************************
 * Copyright (c) 2000, 2017 IBM Corporation and others.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *
 *******************************************************************************/
package org.eclipse.dltk.internal.corext.buildpath;

import java.lang.reflect.InvocationTargetException;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.dltk.core.ModelException;
import org.eclipse.dltk.internal.ui.wizards.buildpath.newsourcepage.DialogPackageExplorerActionGroup;
import org.eclipse.jface.operation.IRunnableWithProgress;



/**
 * Abstract class which represents buildpath modifier operation, this is,
 * Operation that call methods on <code>BuildpathModifier</code>.
 */
public abstract class BuildpathModifierOperation extends BuildpathModifier implements IRunnableWithProgress {
    protected IBuildpathInformationProvider fInformationProvider;
    protected CoreException fException;
    private int fType;
    /**
     * A human readable name for this operation
     */
    private String fName;

    /**
     * Constructor
     *
     * @param listener a <code>IBuildpathModifierListener</code> that is notified about
     * changes on buildpath entries or <code>null</code> if no such notification is
     * necessary.
     * @param informationProvider a provider to offer information to the operation
     * @param name a human readable name for this operation
     * @param type the type of the operation, that is a constant of <code>
     * IBuildpathInformationProvider</code>
     *
     * @see IBuildpathInformationProvider
     * @see BuildpathModifier
     */
    public BuildpathModifierOperation(IBuildpathModifierListener listener, IBuildpathInformationProvider informationProvider, String name, int type) {
        super(listener);
        fInformationProvider= informationProvider;
        fException= null;
        fName= name;
        fType= type;
    }

    protected void handleResult(List result, IProgressMonitor monitor) throws InvocationTargetException{
        /*
         * if (fMonitor != null && fException != null) then
         * the action was called with the run method of
         * the IRunnableWithProgress which will throw an
         * InvocationTargetException in the case that an
         * exception ocurred. Then error handling is
         * done by the client which called run(monitor).
         *
         * Otherwise we pass the information back to the
         * information provider.
         */
        if (monitor == null || fException == null)
            fInformationProvider.handleResult(result, fException, fType);
        else
            throw new InvocationTargetException(fException);
        fException= null;
    }

    /**
     * Method which runs the actions with a progress monitor.<br>
     *
     * @param monitor a progress monitor, can be <code>null</code>
     */
	@Override
	public abstract void run(IProgressMonitor monitor)
			throws InvocationTargetException, InterruptedException;

    /**
     * Get the type converted into a string.
     *
     * @return the ID (that is the type) of this operation as string.
     */
    public String getId() {
        return Integer.toString(fType);
    }

    /**
     * Find out whether this operation can be executed on
     * the provided list of elements.
     *
     * @param elements a list of elements
     * @param types an array of types for each element, that is,
     * the type at position 'i' belongs to the selected element
     * at position 'i'
     *
     * @return <code>true</code> if the operation can be
     * executed on the provided list of elements, <code>
     * false</code> otherwise.
     *
     * @throws ModelException
     */
    public abstract boolean isValid(List elements, int[] types) throws ModelException;

    /**
     * Get a description for this operation. The description depends on
     * the provided type parameter, which must be a constant of
     * <code>DialogPackageExplorerActionGroup</code>. If the type is
     * <code>DialogPackageExplorerActionGroup.MULTI</code>, then the
     * description will be very general to describe the situation of
     * all the different selected objects as good as possible.
     *
     * @param type the type of the selected object, must be a constant of
     * <code>DialogPackageExplorerActionGroup</code>.
     * @return a string describing the operation.
     */
    public abstract String getDescription(int type);

    public String getName() {
        return fName;
    }

    public List getSelectedElements() {
        return fInformationProvider.getSelection().toList();
    }

    public int getTypeId() {
    	return fType;
    }

	public boolean isValid() throws ModelException {
        List selectedElements= getSelectedElements();
        int[] types= new int[selectedElements.size()];
        for(int i= 0; i < types.length; i++) {
            types[i]= DialogPackageExplorerActionGroup.getType(selectedElements.get(i), fInformationProvider.getScriptProject());
        }
		return isValid(selectedElements, types);
	}
}