Package liquibase.command
Class AbstractCommandStep
- java.lang.Object
-
- liquibase.command.AbstractCommandStep
-
- All Implemented Interfaces:
CommandStep
- Direct Known Subclasses:
AbstractCliWrapperCommandStep
,AbstractFutureRollbackCommandStep
,AbstractHelperCommandStep
,AbstractRollbackCommandStep
,AbstractUpdateCommandStep
,CalculateChecksumCommandStep
,ChangelogSyncCommandStep
,ClearChecksumsCommandStep
,DbDocCommandStep
,DiffChangelogCommandStep
,DiffCommandStep
,DropAllCommandStep
,ExecuteSqlCommandStep
,GenerateChangelogCommandStep
,InternalHistoryCommandStep
,InternalSnapshotCommandStep
,ListLocksCommandStep
,MarkNextChangesetRanCommandStep
,ReleaseLocksCommandStep
,ShowSummaryArgument
,SnapshotCommandStep
,SnapshotReferenceCommandStep
,StartH2CommandStep
,StatusCommandStep
,TagCommandStep
,TagExistsCommandStep
,TestSystemDownCommand
,TestSystemUpCommand
,UnexpectedChangesetsCommandStep
,UpdateTestingRollbackCommandStep
,ValidateCommandStep
public abstract class AbstractCommandStep extends Object implements CommandStep
Convenience base class forCommandStep
implementations.
-
-
Field Summary
Fields Modifier and Type Field Description protected static ResourceBundle
coreBundle
-
Fields inherited from interface liquibase.command.CommandStep
ORDER_DEFAULT, ORDER_NOT_APPLICABLE
-
-
Constructor Summary
Constructors Constructor Description AbstractCommandStep()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
adjustCommandDefinition(CommandDefinition commandDefinition)
Default implementation makes no changesint
getOrder(CommandDefinition commandDefinition)
The order in the pipeline that this step should be executed in.List<Class<?>>
providedDependencies()
Returns a list of all the dependency Classes that this step providesList<Class<?>>
requiredDependencies()
Return a list of configured Classes that this command requires to be passed as a dependency.void
validate(CommandScope commandScope)
Default implementation does no additional validation.-
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, run
-
-
-
-
Field Detail
-
coreBundle
protected static ResourceBundle coreBundle
-
-
Method Detail
-
requiredDependencies
public List<Class<?>> requiredDependencies()
Description copied from interface:CommandStep
Return a list of configured Classes that this command requires to be passed as a dependency.- Specified by:
requiredDependencies
in interfaceCommandStep
- Returns:
- list with the required classes types
-
providedDependencies
public List<Class<?>> providedDependencies()
Description copied from interface:CommandStep
Returns a list of all the dependency Classes that this step provides- Specified by:
providedDependencies
in interfaceCommandStep
- Returns:
- list with the provided classes types
-
getOrder
public int getOrder(CommandDefinition commandDefinition)
Description copied from interface:CommandStep
The order in the pipeline that this step should be executed in. Logic is generally based offCommandDefinition.getName()
but it can check other things in the definition such as arguments.- Specified by:
getOrder
in interfaceCommandStep
- Returns:
CommandStep.ORDER_DEFAULT
if the command scope's name matchesCommandStep.defineCommandNames()
. OtherwiseCommandStep.ORDER_NOT_APPLICABLE
-
validate
public void validate(CommandScope commandScope) throws CommandValidationException
Default implementation does no additional validation.- Specified by:
validate
in interfaceCommandStep
- Throws:
CommandValidationException
-
adjustCommandDefinition
public void adjustCommandDefinition(CommandDefinition commandDefinition)
Default implementation makes no changes- Specified by:
adjustCommandDefinition
in interfaceCommandStep
-
-