RunnerDescriptor.java

/*******************************************************************************
 * Copyright (c) 2012-2015 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.api.runner.dto;

import org.eclipse.che.api.project.shared.dto.RunnerEnvironment;
import org.eclipse.che.dto.shared.DTO;
import com.wordnik.swagger.annotations.ApiModelProperty;

import java.util.List;

/**
 * Describes capabilities of {@link org.eclipse.che.api.runner.internal.Runner}.
 *
 * @author andrew00x
 * @see org.eclipse.che.api.runner.internal.Runner
 * @see org.eclipse.che.api.runner.internal.Runner#getName()
 * @see org.eclipse.che.api.runner.internal.SlaveRunnerService#getAvailableRunners()
 */
@DTO
public interface RunnerDescriptor {
    /**
     * Get Runner name.
     *
     * @return runner name
     */
    @ApiModelProperty(value = "Runner name", notes = "Consult docs to get runner name reference")
    String getName();

    /**
     * Set Runner name.
     *
     * @param name
     *         runner name
     */
    void setName(String name);

    RunnerDescriptor withName(String name);

    /**
     * Get optional description of Runner.
     *
     * @return runner description
     */
    @ApiModelProperty(value = "Description")
    String getDescription();

    /**
     * Set optional description of Runner.
     *
     * @param description
     *         runner description
     */
    void setDescription(String description);

    RunnerDescriptor withDescription(String description);

    List<RunnerEnvironment> getEnvironments();

    void setEnvironments(List<RunnerEnvironment> environments);

    RunnerDescriptor withEnvironments(List<RunnerEnvironment> environments);
}