Package liquibase.command

Class AbstractCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

All Implemented Interfaces:

CommandStep

Direct Known Subclasses:

AbstractArgumentCommandStep, AbstractChangelogCommandStep, AbstractCliWrapperCommandStep, AbstractFutureRollbackCommandStep, AbstractHelperCommandStep, AbstractRollbackCommandStep, AbstractUpdateCommandStep, CalculateChecksumCommandStep, ChangelogSyncCommandStep, ClearChecksumsCommandStep, DbDocCommandStep, DiffCommandStep, DropAllCommandStep, ExecuteSqlCommandStep, HistoryCommandStep, InitProjectCommandStep, InternalSnapshotCommandStep, ListLocksCommandStep, LpmCommandStep, MarkNextChangesetRanCommandStep, ReleaseLocksCommandStep, ShowSummaryArgument, SnapshotCommandStep, SnapshotReferenceCommandStep, StartH2CommandStep, StatusCommandStep, StopH2CommandStep, TagCommandStep, TagExistsCommandStep, TestSystemDownCommand, TestSystemUpCommand, UnexpectedChangesetsCommandStep, UpdateTestingRollbackCommandStep, ValidateCommandStep

public abstract class AbstractCommandStep
extends Object
implements CommandStep

Convenience base class for CommandStep 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

Modifier and Type	Method	Description
void	adjustCommandDefinition(CommandDefinition commandDefinition)	Default implementation makes no changes
int	getOrder(CommandDefinition commandDefinition)	The order in the pipeline that this step should be executed in.
protected void	handleOutput(CommandResultsBuilder resultsBuilder, String output)
List<Class<?>>	providedDependencies()	Returns a list of all the dependency Classes that this step provides
List<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, isInternal, run

Field Details

coreBundle

protected static ResourceBundle coreBundle

Constructor Details

AbstractCommandStep

public AbstractCommandStep()

Method Details

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 interface CommandStep

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 interface CommandStep

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 off CommandDefinition.getName() but it can check other things in the definition such as arguments.

Specified by:

getOrder in interface CommandStep

Returns:

CommandStep.ORDER_DEFAULT if the command scope's name matches CommandStep.defineCommandNames(). Otherwise CommandStep.ORDER_NOT_APPLICABLE

validate

public void validate(CommandScope commandScope)
              throws CommandValidationException

Default implementation does no additional validation.

Specified by:

validate in interface CommandStep

Throws:

CommandValidationException

adjustCommandDefinition

public void adjustCommandDefinition(CommandDefinition commandDefinition)

Default implementation makes no changes

Specified by:

adjustCommandDefinition in interface CommandStep

handleOutput

protected void handleOutput(CommandResultsBuilder resultsBuilder,
 String output)
                     throws IOException

Parameters:

resultsBuilder -

output -

Throws:

IOException - Writes the output of command results to the stdout buffer