Top Description Fields Constructors Methods
liquibase.command

public abstract Class AbstractCliWrapperCommandStep

extends AbstractCommandStep
Class Inheritance
Known Direct Subclasses
liquibase.command.core.HistoryCommandStep
Imports
liquibase.exception.CommandExecutionException, liquibase.integration.commandline.LiquibaseCommandLineConfiguration, .Main, java.io.OutputStream, .PrintStream, java.util.*

Deprecated

Convenience base class for CommandSteps that simply wrap calls to liquibase.integration.commandline.Main

Field Summary

Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public
AbstractCliWrapperCommandStep()

Method Summary

Modifier and TypeMethod and Description
protected abstract String[]
collectArguments(CommandScope commandScope)

Called by run(CommandResultsBuilder) to create the actual arguments passed to Main#run(String[]).

protected String[]
collectArguments(CommandScope commandScope, List<String> commandArguments, String positionalArgumentName)

Collects the values from commandScope into an argument array to pass to Main.

protected void
preRunCheck(CommandResultsBuilder resultsBuilder)

protected String[]
removeArgumentValues(String[] allArguments, String... argumentsThatTakeNoValue)

public final void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.AbstractCommandStep:
adjustCommandDefinitiongetOrderprovidedDependenciesrequiredDependenciesvalidate

Constructor Detail

AbstractCliWrapperCommandStepback to summary
public AbstractCliWrapperCommandStep()

Method Detail

collectArgumentsback to summary
protected abstract String[] collectArguments(CommandScope commandScope) throws CommandExecutionException

Called by run(CommandResultsBuilder) to create the actual arguments passed to Main#run(String[]).

Implementations should generally call collectArguments(CommandScope, List, String) and possibly removeArgumentValues(String[], String...)

collectArgumentsback to summary
protected String[] collectArguments(CommandScope commandScope, List<String> commandArguments, String positionalArgumentName) throws CommandExecutionException

Collects the values from commandScope into an argument array to pass to Main. All arguments will values in commandScope will be passed as global arguments EXCEPT for ones listed in the commandArguments. If main takes a "positional argument" like `liquibase tag tagName`, specify the commandScope argument that should be converted to a positional argument in "positionalArgumentName".

See Also
If any arguments should not have a value (like a --verbose flag), see
preRunCheckback to summary
protected void preRunCheck(CommandResultsBuilder resultsBuilder)
removeArgumentValuesback to summary
protected String[] removeArgumentValues(String[] allArguments, String... argumentsThatTakeNoValue)
runback to summary
public final void run(CommandResultsBuilder resultsBuilder) throws Exception

Implements liquibase.command.CommandStep.run.

Doc from liquibase.command.CommandStep.run.

Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in the CommandScope#execute() order.

Annotations
@Override