Package liquibase.command

Class CommandResultDefinition<DataType>

java.lang.Object
liquibase.command.CommandResultDefinition<DataType>
All Implemented Interfaces:
Comparable<CommandResultDefinition<?>>
public class CommandResultDefinition<DataType> extends Object implements Comparable<CommandResultDefinition<?>>
Defines a known, type-safe result from a specific CommandStep.

Because this definition is tied to a specific step, multiple steps in a pipeline can define results of the same name.

See Also:

  • Constructor Details

    • CommandResultDefinition

      protected CommandResultDefinition(String name, Class<DataType> type)

  • Method Details

    • getName

      public String getName()
      The name of the result. Must be camelCase and alphanumeric.

    • getDescription

      public String getDescription()
      The description of the result. Used in generated help documentation.

    • getDataType

      public Class<DataType> getDataType()
      The datatype of the result.

    • getDefaultValue

      public DataType getDefaultValue()
      The default value to use if no value was provided.

    • compareTo

      public int compareTo(CommandResultDefinition<?> o)
      Specified by:
      compareTo in interface Comparable<DataType>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object