Package liquibase.command

Class CommandArgumentDefinition<DataType>

java.lang.Object

liquibase.command.CommandArgumentDefinition<DataType>

All Implemented Interfaces:

Comparable<CommandArgumentDefinition<?>>

public class CommandArgumentDefinition<DataType>
extends Object
implements Comparable<CommandArgumentDefinition<?>>

Defines a known, type-safe argument for a specific CommandStep. Includes metadata about the argument such as a description, if it is required, a default value, etc.

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

See Also:

• for constructing new instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandArgumentDefinition.Building<DataType>	A new CommandArgumentDefinition under construction from CommandBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	compareTo(CommandArgumentDefinition<?> o)
boolean	equals(Object o)
SortedSet<String>	getAliases()	Aliases for the argument.
Set<String>	getForcePrintedAliases()
boolean	getHidden()	Hidden arguments are ones that can be called via integrations, but should not be normally shown in help to users.
int	hashCode()
String	toString()
void	validate(CommandScope commandScope)	Validates that the value stored in the given CommandScope is valid.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandArgumentDefinition

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

Method Details

getAliases

public SortedSet<String> getAliases()

Aliases for the argument. Must be camelCase alphanumeric.

getForcePrintedAliases

public Set<String> getForcePrintedAliases()

getHidden

public boolean getHidden()

Hidden arguments are ones that can be called via integrations, but should not be normally shown in help to users.

validate

public void validate(CommandScope commandScope)
              throws CommandValidationException

Validates that the value stored in the given CommandScope is valid.

Throws:

CommandValidationException - if the stored value is not valid.

compareTo

public int compareTo(CommandArgumentDefinition<?> 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