Package liquibase.command.core.helpers

Class ShowSummaryArgument

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.helpers.ShowSummaryArgument

All Implemented Interfaces:

CommandStep

public class ShowSummaryArgument
extends AbstractCommandStep

This class encapsulates the argument "show-summary", which applies to the update family of commands. The show-summary feature will display a formatted summary table when performing an update command. See ShowSummaryUtil for implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<UpdateSummaryEnum>	SHOW_SUMMARY
static final CommandArgumentDefinition<UpdateSummaryOutputEnum>	SHOW_SUMMARY_OUTPUT

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

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"}}.
boolean	isInternal()	Informational method to determine if this step is internal to Liquibase and should not be disclosed to end users
List<Class<?>>	providedDependencies()	Returns a list of all the dependency Classes that this step provides
void	run(CommandResultsBuilder resultsBuilder)	Performs the business logic.

Methods inherited from class liquibase.command.AbstractCommandStep

adjustCommandDefinition, getOrder, handleOutput, requiredDependencies, 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

SHOW_SUMMARY

public static final CommandArgumentDefinition<UpdateSummaryEnum> SHOW_SUMMARY

SHOW_SUMMARY_OUTPUT

public static final CommandArgumentDefinition<UpdateSummaryOutputEnum> SHOW_SUMMARY_OUTPUT

Constructor Details

ShowSummaryArgument

public ShowSummaryArgument()

Method Details

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

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

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

isInternal

public boolean isInternal()

Description copied from interface: CommandStep

Informational method to determine if this step is internal to Liquibase and should not be disclosed to end users

Returns:

true if this step is internal to Liquibase and should not be shown in the help output