public class CommandDefinition extends Object implements Comparable<CommandDefinition>
CommandFactory.getCommandDefinition(String...)
Modifier | Constructor and Description |
---|---|
protected |
CommandDefinition(String[] name) |
Modifier and Type | Method and Description |
---|---|
void |
add(CommandArgumentDefinition commandArg) |
int |
compareTo(CommandDefinition o) |
boolean |
equals(Object o) |
CommandArgumentDefinition<?> |
getArgument(String argName)
Returns the given argument definition for this command.
|
SortedMap<String,CommandArgumentDefinition<?>> |
getArguments()
Returns the arguments for this command.
|
<T> SortedSet<CommandArgumentDefinition<T>> |
getArguments(Class<T> argumentType)
Convenience method to return the arguments for this command which are of a given type.
|
String |
getGroupHelpFooter() |
String |
getGroupLongDescription(String[] group)
The long description of the given command group.
|
String |
getGroupShortDescription(String[] group)
The short description of the given command group.
|
String |
getHelpFooter() |
boolean |
getHidden()
Hidden commands are ones that can be called via integrations, but should not be normally shown in help to users.
|
boolean |
getInternal()
Internal commands are ones that can be called programmatically, but should not be exposed directly and automatically through integrations.
|
String |
getLongDescription()
The long description of the command.
|
String[] |
getName()
The fully qualified name of this command.
|
List<CommandStep> |
getPipeline()
Returns the steps in the command's pipeline
|
String |
getShortDescription()
The short description of the command.
|
int |
hashCode() |
boolean |
is(String... commandName)
Return true if this command represents the given command
|
void |
setGroupHelpFooter(String groupFooter) |
void |
setGroupLongDescription(String[] group,
String longDescription) |
void |
setGroupShortDescription(String[] group,
String shortDescription)
Sets the short description of the given command group for help docs.
|
void |
setHelpFooter(String footer) |
void |
setHidden(boolean hidden) |
void |
setInternal(boolean internal) |
void |
setLongDescription(String longDescription) |
void |
setShortDescription(String shortDescription) |
protected CommandDefinition(String[] name)
public String[] getName()
public int compareTo(CommandDefinition o)
compareTo
in interface Comparable<CommandDefinition>
public List<CommandStep> getPipeline()
public CommandArgumentDefinition<?> getArgument(String argName)
public SortedMap<String,CommandArgumentDefinition<?>> getArguments()
public <T> SortedSet<CommandArgumentDefinition<T>> getArguments(Class<T> argumentType)
public String getShortDescription()
public void setShortDescription(String shortDescription)
public String getGroupShortDescription(String[] group)
public void setGroupShortDescription(String[] group, String shortDescription)
public String getGroupLongDescription(String[] group)
public String getLongDescription()
public void setLongDescription(String longDescription)
public String getHelpFooter()
public void setHelpFooter(String footer)
public String getGroupHelpFooter()
public void setGroupHelpFooter(String groupFooter)
public void add(CommandArgumentDefinition commandArg)
public boolean getInternal()
public void setInternal(boolean internal)
public boolean getHidden()
public void setHidden(boolean hidden)
public boolean is(String... commandName)
Copyright © 2023 Liquibase.org. All rights reserved.