CommandProducer.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.api.command;

import org.eclipse.che.api.core.model.machine.Machine;

import java.util.Set;

/**
 * Defines the requirements for a component which can produce the commands from the current context.
 * <p>For every registered {@link CommandProducer} an appropriate action
 * will be added in context menus (e.g., explorer, editor tab).
 * <p>Implementor can restrict machine types where command may be executed with {@link #getMachineTypes()}.
 * In that case, sub menu will be created with separate sub actions which are correspond to each machine.
 * <p>Implementations of this interface have to be registered with
 * a GIN multibinder in order to be picked-up on application's start-up.
 *
 * @author Artem Zatsarynnyi
 */
public interface CommandProducer {

    /** Returns the text that should be used as related action's title. */
    String getName();

    /**
     * Whether the command produced by concrete producer is applicable to the current context?
     * Returned value is used for regulating visibility of an appropriate action.
     */
    boolean isApplicable();

    /**
     * Creates a command from the current context.
     * Target for command execution will be provided through {@code machine} parameter.
     * Called when user performs corresponded action.
     */
    CommandImpl createCommand(Machine machine);

    /**
     * Returns machine types for restricting machines where command may be executed.
     * If returns empty set then ws-agent will be used for executing a command.
     */
    Set<String> getMachineTypes();
}