io.bdeploy.common.cli.data.DataResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Public API including dependencies, ready to be used for integrations and plugins.

There is a newer version: 7.3.6

package io.bdeploy.common.cli.data;

import java.util.Map;

/**
 * Represents the result of a CLI tool.
 */
public interface DataResult extends RenderableResult {

    /**
     * @param message the "main" result message.
     */
    public DataResult setMessage(String message);

    /**
     * @param exitCode indicates whether operation was successful or had any errors.
     */
    public DataResult setExitCode(ExitCode exitCode);

    /**
     * @param t the exception in case one happened.
     */
    public DataResult setException(Throwable t);

    /**
     * Adds a data field to the result. This can be any data "produced" by the tool, e.g. an ID generated by the tool, etc.
     *
     * @param name name of the field.
     * @param value the value of the field.
     */
    public DataResult addField(String name, Object value);

    /**
     * @return the fields in the result for testability
     */
    public Map getFields();

    /**
     * @return the message for testability
     */
    public String getMessage();

}