Top Fields Constructors Methods
liquibase.command.core.helpers

public abstract Class AbstractOutputWriterCommandStep

extends AbstractHelperCommandStep
implements CleanUpCommandStep
Class Inheritance
All Implemented Interfaces
liquibase.command.CleanUpCommandStep
Known Direct Subclasses
liquibase.command.core.helpers.OutputWriterCommandStep, liquibase.command.core.helpers.ReferenceDatabaseOutputWriterCommandStep
Imports
liquibase.GlobalConfiguration, .Scope, liquibase.command.CleanUpCommandStep, .CommandResultsBuilder, .CommandScope, liquibase.database.Database, liquibase.executor.Executor, .ExecutorService, .LoggingExecutor, java.io.IOException, .OutputStreamWriter, java.util.Collections, .List

Field Summary

Modifier and TypeField and Description
private OutputStreamWriter
outputStreamWriter

Constructor Summary

AccessConstructor and Description
public
AbstractOutputWriterCommandStep()

Method Summary

Modifier and TypeMethod and Description
public void
cleanUp(CommandResultsBuilder
builder used in this pipeline
resultsBuilder)

Implements liquibase.command.CleanUpCommandStep.cleanUp.

Method invoked to execute the cleanup action.

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 abstract Class<?>
getDatabaseDependency()

Get the database dependency that is required by this class.

public abstract Class<?>
getProvidedWriterDependency()

Get the dependency that is provided by this class.

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 List<Class<?>>
requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

public void
run(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CommandStep.run.

Performs the business logic.

Inherited from liquibase.command.core.helpers.AbstractHelperCommandStep:
adjustCommandDefinition

Field Detail

outputStreamWriterback to summary
private OutputStreamWriter outputStreamWriter

Constructor Detail

AbstractOutputWriterCommandStepback to summary
public AbstractOutputWriterCommandStep()

Method Detail

cleanUpback to summary
public void cleanUp(CommandResultsBuilder resultsBuilder)

Implements liquibase.command.CleanUpCommandStep.cleanUp.

Doc from liquibase.command.CleanUpCommandStep.cleanUp.

Method invoked to execute the cleanup action.

Parameters
resultsBuilder:CommandResultsBuilder

builder used in this pipeline

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
getDatabaseDependencyback to summary
public abstract Class<?> getDatabaseDependency()

Get the database dependency that is required by this class.

getProvidedWriterDependencyback to summary
public abstract Class<?> getProvidedWriterDependency()

Get the dependency that is provided by this class. In some cases this is java.io.Writer, but might be other similar classes depending on the implementation.

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
requiredDependenciesback to summary
public List<Class<?>> requiredDependencies()

Overrides liquibase.command.AbstractCommandStep.requiredDependencies.

Implements liquibase.command.CommandStep.requiredDependencies.

Doc from liquibase.command.CommandStep.requiredDependencies.

Return a list of configured Classes that this command requires to be passed as a dependency.

Returns:List<Class<?>>

list with the required 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