Package liquibase.command.core.helpers

Class DiffOutputControlCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.AbstractHelperCommandStep

liquibase.command.core.helpers.DiffOutputControlCommandStep

All Implemented Interfaces:

CleanUpCommandStep, CommandStep

public class DiffOutputControlCommandStep
extends AbstractHelperCommandStep
implements CleanUpCommandStep

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	Description
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<String>	DATA_OUTPUT_DIR_ARG
static final CommandResultDefinition<DiffOutputControl>	DIFF_OUTPUT_CONTROL
static final CommandArgumentDefinition<String>	EXCLUDE_OBJECTS
static final CommandArgumentDefinition<Boolean>	INCLUDE_CATALOG_ARG
static final CommandArgumentDefinition<String>	INCLUDE_OBJECTS
static final CommandArgumentDefinition<Boolean>	INCLUDE_SCHEMA_ARG
static final 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	Description
DiffOutputControlCommandStep()

Method Summary

Modifier and Type	Method	Description
void	cleanUp(CommandResultsBuilder resultsBuilder)	Method invoked to execute the cleanup action.
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.core.helpers.AbstractHelperCommandStep

adjustCommandDefinition, isInternal

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, handleOutput, validate

Methods inherited from class java.lang.Object

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

Field Details

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

DATA_OUTPUT_DIR_ARG

public static final CommandArgumentDefinition<String> DATA_OUTPUT_DIR_ARG

EXCLUDE_OBJECTS

public static final CommandArgumentDefinition<String> EXCLUDE_OBJECTS

INCLUDE_OBJECTS

public static final CommandArgumentDefinition<String> INCLUDE_OBJECTS

DIFF_OUTPUT_CONTROL

public static final CommandResultDefinition<DiffOutputControl> DIFF_OUTPUT_CONTROL

Constructor Details

DiffOutputControlCommandStep

public DiffOutputControlCommandStep()

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

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

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

Specified by:

defineCommandNames in interface CommandStep

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.

Specified by:

run in interface CommandStep

Throws:

Exception

outputBestPracticeMessage

protected void outputBestPracticeMessage()

cleanUp

public void cleanUp(CommandResultsBuilder resultsBuilder)

Description copied from interface: CleanUpCommandStep

Method invoked to execute the cleanup action.

Specified by:

cleanUp in interface CleanUpCommandStep

Parameters:

resultsBuilder - builder used in this pipeline