Liquibase 4.26.0 · liquibase.command.CommandStep · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	ORDER_DEFAULT Deprecated Returned by `getOrder(CommandDefinition)` if you are unsure where in the pipeline your step should go, use this value.
public static final int	ORDER_NOT_APPLICABLE Deprecated Returned by `getOrder(CommandDefinition)` if this step should not be a part of the pipeline.

Method Summary

Modifier and Type	Method and Description
public void	adjustCommandDefinition(CommandDefinition commandDefinition) Called by the command pipeline setup to adjust the `CommandDefinition` metadata about the overall command.
public String[][]	defineCommandNames() Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
public int	Returns: -1 if this step does not apply to the given command getOrder(CommandDefinition commandDefinition) Deprecated 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.
public List<Class<?>>	Returns: list with the provided classes types providedDependencies() Returns a list of all the dependency Classes that this step provides
public List<Class<?>>	Returns: list with the required classes types requiredDependencies() Return a list of configured Classes that this command requires to be passed as a dependency.
public void	run(CommandResultsBuilder resultsBuilder) Performs the business logic.
public void	validate(CommandScope commandScope) Validates that the `CommandScope` is correctly set up for this step to run.

Field Detail

ORDER_DEFAULT	back to summary
public static final int ORDER_DEFAULT Deprecated Returned by `getOrder(CommandDefinition)` if you are unsure where in the pipeline your step should go, use this value. Annotations @Deprecated

ORDER_NOT_APPLICABLE	back to summary
public static final int ORDER_NOT_APPLICABLE Deprecated Returned by `getOrder(CommandDefinition)` if this step should not be a part of the pipeline. Annotations @Deprecated

Method Detail

adjustCommandDefinition	back to summary
public void adjustCommandDefinition(CommandDefinition commandDefinition) Called by the command pipeline setup to adjust the `CommandDefinition` metadata about the overall command. This method should not be called directly. It is called by the overall pipeline logic in the `CommandFactory#getCommandDefinition(String...)`.

defineCommandNames	back to summary
public String[][] 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

defineCommandNames

back to summary

public String[][] 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

getOrder back to summary

getOrder	back to summary
public int getOrder(CommandDefinition commandDefinition) Deprecated 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. Returns:int -1 if this step does not apply to the given command Annotations @Deprecated

public int getOrder(CommandDefinition commandDefinition)

Deprecated

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.

Returns:int

-1 if this step does not apply to the given command

Annotations

@Deprecated

providedDependencies	back to summary
public List<Class<?>> providedDependencies() Returns a list of all the dependency Classes that this step provides Returns:List<Class<?>> list with the provided classes types

providedDependencies

back to summary

public List<Class<?>> providedDependencies()

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

Returns:List<Class<?>>: list with the provided classes types

requiredDependencies	back to summary
public List<Class<?>> 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

requiredDependencies

back to summary

public List<Class<?>> 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

run	back to summary
public void run(CommandResultsBuilder resultsBuilder) throws Exception Performs the business logic. This method should not be called directly. It is called by the overall pipeline logic in the `CommandScope#execute()` order.

validate	back to summary
public void validate(CommandScope commandScope) throws CommandValidationException Validates that the `CommandScope` is correctly set up for this step to run. Any validation in `CommandArgumentDefinition#validate(CommandScope)` will be checked previous to this method being called.

public Interface CommandStep

Field Summary

Method Summary

Field Detail

Method Detail