Liquibase 4.26.0 · liquibase.command.CommandDefinition

Modifier and Type	Field and Description
private List<String[]>	aliases The aliases for the command's name.
private final SortedMap<String, CommandArgumentDefinition<?>>	arguments
private final String	concatName
private String	footer
private String	groupFooter
private final Map<String, String>	groupLongDescription
private final Map<String, String>	groupShortDescription
private boolean	hidden
private boolean	internal
private String	longDescription
private final String[]	name
private final SortedSet<CommandStep>	pipeline Stored as a SortedSet even though exposed as a list for easier internal management
private String	shortDescription

Access	Constructor and Description
protected	CommandDefinition(String[] name)

Method Summary

Modifier and Type	Method and Description
pack-priv void	add(CommandStep step)
public void	add(CommandArgumentDefinition<DataType> commandArg)
public void	addAlias(String[] alias) Add an alias to the command.
public int	compareTo(CommandDefinition the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public CommandArgumentDefinition<?>	getArgument(String argName) Returns the given argument definition for this command.
public SortedMap<String, CommandArgumentDefinition<?>>	getArguments() Returns the arguments for this command.
public <T> SortedSet<CommandArgumentDefinition<T>>	getArguments(Class<T> argumentType) Convenience method to return the arguments for this command which are of a given type.
public String	getGroupHelpFooter()
public String	getGroupLongDescription(String[] group) The long description of the given command group.
public String	getGroupShortDescription(String[] group) The short description of the given command group.
public String	getHelpFooter()
public boolean	getHidden() Hidden commands are ones that can be called via integrations, but should not be normally shown in help to users.
public boolean	getInternal() Internal commands are ones that can be called programmatically, but should not be exposed directly and automatically through integrations.
public String	getLongDescription() The long description of the command.
public String[]	getName() The fully qualified name of this command.
public List<CommandStep>	getPipeline() Returns the steps in the command's pipeline
public String	getShortDescription() The short description of the command.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	is(String... commandName) Return true if this command represents the given command
public void	setGroupHelpFooter(String groupFooter)
public void	setGroupLongDescription(String[] group, String longDescription)
public void	setGroupShortDescription(String[] group, String shortDescription) Sets the short description of the given command group for help docs.
public void	setHelpFooter(String footer)
public void	setHidden(boolean hidden)
public void	setInternal(boolean internal)
public void	setLongDescription(String longDescription)
public void	setShortDescription(String shortDescription)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

aliases	back to summary
private List<String[]> aliases The aliases for the command's name. Aliases show up in the help output. Annotations @lombok.Getter

arguments	back to summary
private final SortedMap<String, CommandArgumentDefinition<?>> arguments

concatName	back to summary
private final String concatName

footer	back to summary
private String footer

groupFooter	back to summary
private String groupFooter

groupLongDescription	back to summary
private final Map<String, String> groupLongDescription

groupShortDescription	back to summary
private final Map<String, String> groupShortDescription

hidden	back to summary
private boolean hidden

internal	back to summary
private boolean internal

longDescription	back to summary
private String longDescription

name	back to summary
private final String[] name

pipeline	back to summary
private final SortedSet<CommandStep> pipeline Stored as a SortedSet even though exposed as a list for easier internal management

shortDescription	back to summary
private String shortDescription

CommandDefinition	back to summary
protected CommandDefinition(String[] name)

Method Detail

add	back to summary
pack-priv void add(CommandStep step)

add	back to summary
public void add(CommandArgumentDefinition<DataType> commandArg)

addAlias	back to summary
public void addAlias(String[] alias) Add an alias to the command.

compareTo back to summary

compareTo	back to summary
public int compareTo(CommandDefinition o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:CommandDefinition the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(CommandDefinition o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:CommandDefinition: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getArgument	back to summary
public CommandArgumentDefinition<?> getArgument(String argName) Returns the given argument definition for this command. Handles argument name smoothing. Returns null if no argument matches.

getArguments	back to summary
public SortedMap<String, CommandArgumentDefinition<?>> getArguments() Returns the arguments for this command.

getArguments	back to summary
public <T> SortedSet<CommandArgumentDefinition<T>> getArguments(Class<T> argumentType) Convenience method to return the arguments for this command which are of a given type.

getGroupHelpFooter	back to summary
public String getGroupHelpFooter()

getGroupLongDescription	back to summary
public String getGroupLongDescription(String[] group) The long description of the given command group. Used in help docs. If multiple command commands set different descriptions for the group, which version will be shown in any rolled up help is undefined.

getGroupShortDescription	back to summary
public String getGroupShortDescription(String[] group) The short description of the given command group. Used in help docs.

getHelpFooter	back to summary
public String getHelpFooter()

getHidden	back to summary
public boolean getHidden() Hidden commands are ones that can be called via integrations, but should not be normally shown in help to users. "Alias" or legacy commands are often marked as hidden commands.

getInternal	back to summary
public boolean getInternal() Internal commands are ones that can be called programmatically, but should not be exposed directly and automatically through integrations.

getLongDescription	back to summary
public String getLongDescription() The long description of the command. Used in help docs.

getName	back to summary
public String[] getName() The fully qualified name of this command.

getPipeline	back to summary
public List<CommandStep> getPipeline() Returns the steps in the command's pipeline

getShortDescription	back to summary
public String getShortDescription() The short description of the command. Used in help docs.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

is	back to summary
public boolean is(String... commandName) Return true if this command represents the given command

setGroupHelpFooter	back to summary
public void setGroupHelpFooter(String groupFooter)

setGroupLongDescription	back to summary
public void setGroupLongDescription(String[] group, String longDescription)

setGroupShortDescription	back to summary
public void setGroupShortDescription(String[] group, String shortDescription) Sets the short description of the given command group for help docs. If multiple command commands set different descriptions for the group, which version will be shown in any rolled up help is undefined.

setHelpFooter	back to summary
public void setHelpFooter(String footer)

setHidden	back to summary
public void setHidden(boolean hidden)

setInternal	back to summary
public void setInternal(boolean internal)

setLongDescription	back to summary
public void setLongDescription(String longDescription)

setShortDescription	back to summary
public void setShortDescription(String shortDescription)

public Class CommandDefinition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail