Package liquibase.command.core.init

Class InitProjectCommandStep

java.lang.Object

liquibase.command.AbstractCommandStep

liquibase.command.core.init.InitProjectCommandStep

All Implemented Interfaces:

CommandStep

public class InitProjectCommandStep
extends AbstractCommandStep

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InitProjectCommandStep.FileTypeEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	COMMAND_NAME
static final CommandArgumentDefinition<Boolean>	COPY_EXAMPLE_CHECKS_PACKAGE_FILE
static final CommandArgumentDefinition<Boolean>	COPY_EXAMPLE_FLOW_FILES
static final CommandArgumentDefinition<String>	INIT_CHANGELOG_FILE_ARG
static final CommandArgumentDefinition<String>	INIT_DEFAULTS_FILE_ARG
static final CommandArgumentDefinition<String>	INIT_FORMAT_ARG
static final CommandArgumentDefinition<String>	INIT_PROJECT_DIR_ARG
static final CommandArgumentDefinition<Boolean>	INIT_PROJECT_GUIDE_ARG
static final CommandArgumentDefinition<Boolean>	INIT_PROJECT_KEEP_TEMP_FILES_ARG
static final CommandArgumentDefinition<Boolean>	INIT_PROJECT_RECURSIVE_ARG
static final CommandArgumentDefinition<String>	PASSWORD_ARG
static final String	SHOULD_BACKUP_DEFAULTS_FILE_ARG
static final CommandArgumentDefinition<String>	URL_ARG
static final String	USED_H2_KEY	The key that will be used in the command results map to indicate whether the user selected values which indicate that they are using H2 as their database of choice.
static final CommandArgumentDefinition<String>	USERNAME_ARG

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

Method Summary

Modifier and Type	Method	Description
void	adjustCommandDefinition(CommandDefinition commandDefinition)	Default implementation makes no changes
String[][]	defineCommandNames()	Defines new command names For example, if it is part of `liquibase update`, this should return new String[][]{ new String[] {"update"}}.
static void	outputEndInstructions(boolean wasDefaultProjectDirValueUsed, ConfiguredValue<String> defaultsFileConfig, String projectDir, boolean usedH2)
final void	run(CommandResultsBuilder resultsBuilder)	Performs the business logic.

Methods inherited from class liquibase.command.AbstractCommandStep

getOrder, handleOutput, providedDependencies, 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

INIT_PROJECT_DIR_ARG

public static final CommandArgumentDefinition<String> INIT_PROJECT_DIR_ARG

INIT_FORMAT_ARG

public static final CommandArgumentDefinition<String> INIT_FORMAT_ARG

INIT_CHANGELOG_FILE_ARG

public static final CommandArgumentDefinition<String> INIT_CHANGELOG_FILE_ARG

INIT_DEFAULTS_FILE_ARG

public static final CommandArgumentDefinition<String> INIT_DEFAULTS_FILE_ARG

INIT_PROJECT_GUIDE_ARG

public static final CommandArgumentDefinition<Boolean> INIT_PROJECT_GUIDE_ARG

INIT_PROJECT_RECURSIVE_ARG

public static final CommandArgumentDefinition<Boolean> INIT_PROJECT_RECURSIVE_ARG

INIT_PROJECT_KEEP_TEMP_FILES_ARG

public static final CommandArgumentDefinition<Boolean> INIT_PROJECT_KEEP_TEMP_FILES_ARG

URL_ARG

public static final CommandArgumentDefinition<String> URL_ARG

USERNAME_ARG

public static final CommandArgumentDefinition<String> USERNAME_ARG

PASSWORD_ARG

public static final CommandArgumentDefinition<String> PASSWORD_ARG

COPY_EXAMPLE_FLOW_FILES

public static final CommandArgumentDefinition<Boolean> COPY_EXAMPLE_FLOW_FILES

COPY_EXAMPLE_CHECKS_PACKAGE_FILE

public static final CommandArgumentDefinition<Boolean> COPY_EXAMPLE_CHECKS_PACKAGE_FILE

SHOULD_BACKUP_DEFAULTS_FILE_ARG

public static final String SHOULD_BACKUP_DEFAULTS_FILE_ARG

See Also:

• Constant Field Values

USED_H2_KEY

public static final String USED_H2_KEY

The key that will be used in the command results map to indicate whether the user selected values which indicate that they are using H2 as their database of choice.

See Also:

• Constant Field Values

Constructor Details

InitProjectCommandStep

public InitProjectCommandStep()

Method Details

run

public final 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

outputEndInstructions

public static void outputEndInstructions(boolean wasDefaultProjectDirValueUsed,
 ConfiguredValue<String> defaultsFileConfig,
 String projectDir,
 boolean usedH2)

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

adjustCommandDefinition

public void adjustCommandDefinition(CommandDefinition commandDefinition)

Description copied from class: AbstractCommandStep

Default implementation makes no changes

Specified by:

adjustCommandDefinition in interface CommandStep

Overrides:

adjustCommandDefinition in class AbstractCommandStep