Top Description Fields Constructors Methods
liquibase.command.core.helpers

public Class ShowSummaryArgument

extends AbstractCommandStep
Class Inheritance
Imports
liquibase.UpdateSummaryEnum, .UpdateSummaryOutputEnum, liquibase.command.*, java.util.Arrays, .Collections, .List
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 liquibase.util.ShowSummaryUtil for implementation.

Field Summary

Modifier and TypeField and Description
protected static final String[]
COMMAND_NAME

public static final CommandArgumentDefinition<UpdateSummaryEnum>
SHOW_SUMMARY

public static final CommandArgumentDefinition<UpdateSummaryOutputEnum>
SHOW_SUMMARY_OUTPUT

Inherited from liquibase.command.AbstractCommandStep:
coreBundle

Constructor Summary

AccessConstructor and Description
public
ShowSummaryArgument()

Method Summary

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

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Default implementation makes no changes

public String[][]
defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

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

public List<Class<?>>
providedDependencies()

Overrides liquibase.command.AbstractCommandStep.providedDependencies.

Implements liquibase.command.CommandStep.providedDependencies.

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

public void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.AbstractCommandStep:
getOrderrequiredDependenciesvalidate

Field Detail

COMMAND_NAMEback to summary
protected static final String[] COMMAND_NAME
SHOW_SUMMARYback to summary
public static final CommandArgumentDefinition<UpdateSummaryEnum> SHOW_SUMMARY
SHOW_SUMMARY_OUTPUTback to summary
public static final CommandArgumentDefinition<UpdateSummaryOutputEnum> SHOW_SUMMARY_OUTPUT

Constructor Detail

ShowSummaryArgumentback to summary
public ShowSummaryArgument()

Method Detail

adjustCommandDefinitionback to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition)

Overrides liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Implements liquibase.command.CommandStep.adjustCommandDefinition.

Doc from liquibase.command.AbstractCommandStep.adjustCommandDefinition.

Default implementation makes no changes

Annotations
@Override
defineCommandNamesback to summary
public String[][] defineCommandNames()

Implements liquibase.command.CommandStep.defineCommandNames.

Doc from liquibase.command.CommandStep.defineCommandNames.

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

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

Overrides liquibase.command.AbstractCommandStep.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
runback to summary
public void run(CommandResultsBuilder resultsBuilder) throws Exception

Implements liquibase.command.CommandStep.run.

Doc from liquibase.command.CommandStep.run.

Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in the CommandScope#execute() order.

Annotations
@Override