Package liquibase.command
Class AbstractCliWrapperCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- liquibase.command.AbstractCliWrapperCommandStep
-
- All Implemented Interfaces:
CommandStep
- Direct Known Subclasses:
ClearChecksumsCommandStep
,HistoryCommandStep
public abstract class AbstractCliWrapperCommandStep extends AbstractCommandStep
Deprecated.Convenience base class forCommandStep
s that simply wrap calls toMain
-
-
Field Summary
-
Fields inherited from class liquibase.command.AbstractCommandStep
coreBundle
-
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
-
Constructor Summary
Constructors Constructor Description AbstractCliWrapperCommandStep()
Deprecated.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected abstract String[]
collectArguments(CommandScope commandScope)
Deprecated.Called byrun(CommandResultsBuilder)
to create the actual arguments passed toMain.run(String[])
.protected String[]
collectArguments(CommandScope commandScope, List<String> commandArguments, String positionalArgumentName)
Deprecated.Collects the values from commandScope into an argument array to pass toMain
.protected void
preRunCheck(CommandResultsBuilder resultsBuilder)
Deprecated.protected String[]
removeArgumentValues(String[] allArguments, String... argumentsThatTakeNoValue)
Deprecated.void
run(CommandResultsBuilder resultsBuilder)
Deprecated.Performs the business logic.-
Methods inherited from class liquibase.command.AbstractCommandStep
adjustCommandDefinition, getOrder, providedDependencies, requiredDependencies, validate
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface liquibase.command.CommandStep
defineCommandNames
-
-
-
-
Method Detail
-
run
public final void run(CommandResultsBuilder resultsBuilder) throws Exception
Deprecated.Description copied from interface:CommandStep
Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in theCommandScope.execute()
order.- Throws:
Exception
-
preRunCheck
protected void preRunCheck(CommandResultsBuilder resultsBuilder)
Deprecated.
-
collectArguments
protected abstract String[] collectArguments(CommandScope commandScope) throws CommandExecutionException
Deprecated.Called byrun(CommandResultsBuilder)
to create the actual arguments passed toMain.run(String[])
.Implementations should generally call
collectArguments(CommandScope, List, String)
and possiblyremoveArgumentValues(String[], String...)
- Throws:
CommandExecutionException
-
collectArguments
protected String[] collectArguments(CommandScope commandScope, List<String> commandArguments, String positionalArgumentName) throws CommandExecutionException
Deprecated.Collects the values from commandScope into an argument array to pass toMain
. 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".
-
-