Package liquibase.command.core.helpers

Class ChangeExecListenerCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.AbstractHelperCommandStep

liquibase.command.core.helpers.ChangeExecListenerCommandStep

All Implemented Interfaces:

CommandStep

public class ChangeExecListenerCommandStep
extends AbstractHelperCommandStep

Creates a ChangeExecListener or utilizes the one provided as argument

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandArgumentDefinition<ChangeExecListener>	CHANGE_EXEC_LISTENER_ARG
static final CommandArgumentDefinition<String>	CHANGE_EXEC_LISTENER_CLASS_ARG
static final CommandArgumentDefinition<String>	CHANGE_EXEC_LISTENER_PROPERTIES_FILE_ARG
protected static final String[]	COMMAND_NAME

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
ChangeExecListenerCommandStep()

Method Summary

Modifier and Type	Method	Description
String[][]	defineCommandNames()	Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
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

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 Details

COMMAND_NAME

protected static final String[] COMMAND_NAME

CHANGE_EXEC_LISTENER_CLASS_ARG

public static final CommandArgumentDefinition<String> CHANGE_EXEC_LISTENER_CLASS_ARG

CHANGE_EXEC_LISTENER_PROPERTIES_FILE_ARG

public static final CommandArgumentDefinition<String> CHANGE_EXEC_LISTENER_PROPERTIES_FILE_ARG

CHANGE_EXEC_LISTENER_ARG

public static final CommandArgumentDefinition<ChangeExecListener> CHANGE_EXEC_LISTENER_ARG

Constructor Details

ChangeExecListenerCommandStep

public ChangeExecListenerCommandStep()

Method Details

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

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

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

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