CommandConfigurationFactory.java

/*******************************************************************************
 * Copyright (c) 2012-2016 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.extension.machine.client.command;

import org.eclipse.che.api.machine.shared.dto.CommandDto;

import javax.validation.constraints.NotNull;

/**
 * Factory for {@link CommandConfiguration} instances.
 *
 * @param <T>
 *         type of the command configuration which this factory produces
 * @author Artem Zatsarynnyi
 */
public abstract class CommandConfigurationFactory<T extends CommandConfiguration> {

    private final CommandType commandType;

    /**
     * Creates new command configuration factory for the specified command type.
     *
     * @param commandType
     *         type of the command configuration which this factory should create
     */
    protected CommandConfigurationFactory(@NotNull CommandType commandType) {
        this.commandType = commandType;
    }

    /** Returns type of the command configuration which this factory creates. */
    @NotNull
    public CommandType getCommandType() {
        return commandType;
    }

    /**
     * Creates a new command configuration based on the given {@link CommandDto}.
     *
     * @param descriptor
     *         {@link CommandDto}
     * @throws IllegalArgumentException
     *         if <code>descriptor</code> represents not a valid command.
     */
    @NotNull
    public abstract T createFromDto(@NotNull CommandDto descriptor);
}