liquibase.command.core.helpers

Class DiffOutputControlCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.DiffOutputControlCommandStep

All Implemented Interfaces:

CommandStep

public class DiffOutputControlCommandStep
extends AbstractCommandStep

Internal command step to be used on pipeline to instantiate a DiffOutputControl object that is mainly used by diffChangeLog/generateChangeLog .

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	COMMAND_NAME
static CommandResultDefinition<DiffOutputControl>	DIFF_OUTPUT_CONTROL
static CommandArgumentDefinition<Boolean>	INCLUDE_CATALOG_ARG
static CommandArgumentDefinition<Boolean>	INCLUDE_SCHEMA_ARG
static CommandArgumentDefinition<Boolean>	INCLUDE_TABLESPACE_ARG

Fields inherited from class liquibase.command.AbstractCommandStep

coreBundle

Fields inherited from interface liquibase.command.CommandStep

ORDER_DEFAULT, ORDER_NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
DiffOutputControlCommandStep()

Method Summary

Modifier and Type	Method and Description
void	adjustCommandDefinition(CommandDefinition commandDefinition) Default implementation makes no changes
String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
protected void	outputBestPracticeMessage()
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	run(CommandResultsBuilder resultsBuilder) Performs the business logic.

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMAND_NAME

public static final String[] COMMAND_NAME

INCLUDE_CATALOG_ARG

public static final CommandArgumentDefinition<Boolean> INCLUDE_CATALOG_ARG

INCLUDE_SCHEMA_ARG

public static final CommandArgumentDefinition<Boolean> INCLUDE_SCHEMA_ARG

INCLUDE_TABLESPACE_ARG

public static final CommandArgumentDefinition<Boolean> INCLUDE_TABLESPACE_ARG

DIFF_OUTPUT_CONTROL

public static final CommandResultDefinition<DiffOutputControl> DIFF_OUTPUT_CONTROL

Constructor Detail

DiffOutputControlCommandStep

public DiffOutputControlCommandStep()

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

Overrides:

requiredDependencies in class AbstractCommandStep

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

Overrides:

providedDependencies in class AbstractCommandStep

Returns:

list with the provided classes types

adjustCommandDefinition

public void adjustCommandDefinition(CommandDefinition commandDefinition)

Description copied from class: AbstractCommandStep

Default implementation makes no changes

Specified by:

adjustCommandDefinition in interface CommandStep

Overrides:

adjustCommandDefinition in class AbstractCommandStep

defineCommandNames

public String[][] defineCommandNames()

Description copied from interface: CommandStep

Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}. If it is a part of `liquibase example init`, this should return {"example", "init"}.

This is used to determine the available command names.

This can return null if this step is not defining a new command but "cross-cutting" existing commands

run

public void run(CommandResultsBuilder resultsBuilder)
         throws Exception

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 the CommandScope.execute() order.

Throws:

Exception

outputBestPracticeMessage

protected void outputBestPracticeMessage()