Top Description Fields Constructors Methods
liquibase.command

public abstract Class AbstractCommandStep

extends Object
implements CommandStep
Class Inheritance
All Implemented Interfaces
liquibase.command.CommandStep
Known Direct Subclasses
liquibase.command.core.SnapshotReferenceCommandStep, liquibase.command.core.AbstractFutureRollbackCommandStep, liquibase.command.core.AbstractRollbackCommandStep, liquibase.command.core.AbstractUpdateCommandStep, liquibase.command.core.CalculateChecksumCommandStep, liquibase.command.core.ChangelogSyncCommandStep, liquibase.command.core.ClearChecksumsCommandStep, liquibase.command.core.DbDocCommandStep, liquibase.command.core.DiffCommandStep, liquibase.command.core.DropAllCommandStep, liquibase.command.core.ExecuteSqlCommandStep, liquibase.command.core.InternalHistoryCommandStep, liquibase.command.core.InternalSnapshotCommandStep, liquibase.command.core.ListLocksCommandStep, liquibase.command.core.MarkNextChangesetRanCommandStep, liquibase.command.core.ReleaseLocksCommandStep, liquibase.command.core.SnapshotCommandStep, liquibase.command.core.StartH2CommandStep, liquibase.command.core.StatusCommandStep, liquibase.command.core.TagCommandStep, liquibase.command.core.TagExistsCommandStep, liquibase.command.core.UnexpectedChangesetsCommandStep, liquibase.command.core.UpdateTestingRollbackCommandStep, liquibase.command.core.ValidateCommandStep, liquibase.command.core.helpers.AbstractArgumentCommandStep, liquibase.command.core.helpers.AbstractChangelogCommandStep, liquibase.command.core.helpers.AbstractHelperCommandStep, liquibase.command.core.helpers.ShowSummaryArgument, liquibase.command.AbstractCliWrapperCommandStep
Imports
liquibase.exception.CommandValidationException, liquibase.util.StringUtil, java.util.Arrays, .Collections, .List, .ResourceBundle

Convenience base class for CommandStep implementations.

Field Summary

Modifier and TypeField and Description
protected static ResourceBundle

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
adjustCommandDefinition(CommandDefinition commandDefinition)

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Default implementation makes no changes

public int

Returns:

ORDER_DEFAULT if the command scope's name matches defineCommandNames(). Otherwise ORDER_NOT_APPLICABLE
getOrder
(CommandDefinition commandDefinition)

Implements liquibase.command.CommandStep.getOrder.

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.

public List<Class<?>>
providedDependencies()

Implements liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

public List<Class<?>>
requiredDependencies()

Implements liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

public void
validate(CommandScope commandScope)

Implements liquibase.command.CommandStep.validate.

Default implementation does no additional validation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

coreBundleback to summary
protected static ResourceBundle coreBundle

Constructor Detail

AbstractCommandStepback to summary
public AbstractCommandStep()

Method Detail

adjustCommandDefinitionback to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition)

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Default implementation makes no changes

Annotations
@Override
getOrderback to summary
public int getOrder(CommandDefinition commandDefinition)

Implements liquibase.command.CommandStep.getOrder.

Doc from liquibase.command.CommandStep.getOrder.

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.

Returns:int

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

Annotations
@Override
providedDependenciesback to summary
public List<Class<?>> providedDependencies()

Implements liquibase.command.CommandStep.providedDependencies.

Doc from liquibase.command.CommandStep.providedDependencies.

Returns a list of all the dependency Classes that this step provides

Returns:List<Class<?>>

list with the provided classes types

Annotations
@Override
requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Implements liquibase.command.CommandStep.requiredDependencies.

Doc from liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

Returns:List<Class<?>>

list with the required classes types

Annotations
@Override
validateback to summary
public void validate(CommandScope commandScope) throws CommandValidationException

Implements liquibase.command.CommandStep.validate.

Default implementation does no additional validation.

Annotations
@Override