liquibase.sdk.convert

Class ConvertCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.sdk.convert.ConvertCommandStep

All Implemented Interfaces:

CommandStep

public class ConvertCommandStep
extends AbstractCommandStep

Field Summary

Fields

Modifier and Type	Field and Description
static CommandArgumentDefinition<String>	CLASSPATH_ARG
static CommandArgumentDefinition<String>	OUT_ARG
static CommandArgumentDefinition<String>	SRC_ARG

Fields inherited from interface liquibase.command.CommandStep

ORDER_DEFAULT, ORDER_NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
ConvertCommandStep()

Method Summary

Modifier and Type	Method and Description
String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
int	getOrder(CommandDefinition commandDefinition) The order in the pipeline that this step should be executed in.
void	run(CommandResultsBuilder resultsBuilder) Performs the business logic.

Methods inherited from class liquibase.command.AbstractCommandStep

adjustCommandDefinition, validate

Methods inherited from class java.lang.Object

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

Field Detail

SRC_ARG

public static final CommandArgumentDefinition<String> SRC_ARG

OUT_ARG

public static final CommandArgumentDefinition<String> OUT_ARG

CLASSPATH_ARG

public static final CommandArgumentDefinition<String> CLASSPATH_ARG

Constructor Detail

ConvertCommandStep

public ConvertCommandStep()

Method Detail

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.

getOrder

public int getOrder(CommandDefinition commandDefinition)

Description copied from interface: CommandStep

The order in the pipeline that this step should be executed in. Logic is generally based off CommandDefinition.getName() but it can check other things in the definition such as arguments.

Specified by:

getOrder in interface CommandStep

Overrides:

getOrder in class AbstractCommandStep

Returns:

CommandStep.ORDER_DEFAULT if the command scope's name matches CommandStep.defineCommandNames(). Otherwise CommandStep.ORDER_NOT_APPLICABLE

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 CommandStep.getOrder(CommandDefinition) order.

Throws:

Exception