liquibase.command.CommandResultDefinition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of liquibase-core Show documentation

Liquibase is a tool for managing and executing database changes.

There is a newer version: 4.29.2

package liquibase.command;

import java.util.Objects;

/**
 * Defines a known, type-safe result from a specific {@link CommandStep}.
 * 
 * Because this definition is tied to a specific step, multiple steps in a pipeline can define results of the same name.
 *
 * @see CommandBuilder#result(String, Class) for constructing new instances.
 */
public class CommandResultDefinition implements Comparable> {

    private String name;
    private String description;
    private Class dataType;
    private DataType defaultValue;

    protected CommandResultDefinition(String name, Class type) {
        this.name = name;
        this.dataType = type;
    }

    /**
     * The name of the result. Must be camelCase and alphanumeric.
     */
    public String getName() {
        return name;
    }

    /**
     * The description of the result. Used in generated help documentation.
     */
    public String getDescription() {
        return description;
    }

    /**
     * The datatype of the result.
     */
    public Class getDataType() {
        return dataType;
    }

    /**
     * The default value to use if no value was provided.
     */
    public DataType getDefaultValue() {
        return defaultValue;
    }

    @Override
    public int compareTo(CommandResultDefinition o) {
        return this.getName().compareTo(o.getName());
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        CommandResultDefinition that = (CommandResultDefinition) o;
        return Objects.equals(name, that.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }

    @Override
    public String toString() {
        return getName();
    }

    public static class Building {
        private final CommandResultDefinition newCommandResult;

        Building(CommandResultDefinition newCommandResult) {
            this.newCommandResult = newCommandResult;
        }

        /**
         * Sets the description for this result.
         */
        public Building description(String description) {
            this.newCommandResult.description = description;

            return this;
        }

        /**
         * Set the default value for this result.
         */
        public Building defaultValue(DataType defaultValue) {
            newCommandResult.defaultValue = defaultValue;

            return this;
        }

        /**
         * Complete construction and register the definition with the rest of the system.
         */
        public CommandResultDefinition build() {
            return newCommandResult;
        }

    }

}