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:

for constructing new instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandResultDefinition.Building<DataType>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandResultDefinition(String name, Class<DataType> type)

Method Summary

Modifier and Type	Method and Description
int	compareTo(CommandResultDefinition<?> o)
boolean	equals(Object o)
Class<DataType>	getDataType() The datatype of the result.
DataType	getDefaultValue() The default value to use if no value was provided.
String	getDescription() The description of the result.
String	getName() The name of the result.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandResultDefinition

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

Method Detail

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<CommandResultDefinition<?>>

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