io.dropwizard.migrations

Class AbstractLiquibaseCommand<T extends Configuration>

java.lang.Object

io.dropwizard.cli.Command

io.dropwizard.cli.ConfiguredCommand<T>

io.dropwizard.migrations.AbstractLiquibaseCommand<T>

Direct Known Subclasses:

DbCalculateChecksumCommand, DbClearChecksumsCommand, DbCommand, DbDropAllCommand, DbDumpCommand, DbFastForwardCommand, DbGenerateDocsCommand, DbLocksCommand, DbMigrateCommand, DbPrepareRollbackCommand, DbRollbackCommand, DbStatusCommand, DbTagCommand, DbTestCommand

public abstract class AbstractLiquibaseCommand<T extends Configuration>
extends ConfiguredCommand<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLiquibaseCommand(String name, String description, DatabaseConfiguration<T> strategy, Class<T> configurationClass, String migrationsFileName)

Method Summary

Modifier and Type	Method and Description
void	configure(net.sourceforge.argparse4j.inf.Subparser subparser) Configure the command's Subparser.
protected Class<T>	getConfigurationClass() Returns the Class of the configuration type.
protected void	run(Bootstrap<T> bootstrap, net.sourceforge.argparse4j.inf.Namespace namespace, T configuration) Runs the command with the given Bootstrap and Configuration.
protected abstract void	run(net.sourceforge.argparse4j.inf.Namespace namespace, liquibase.Liquibase liquibase)

Methods inherited from class io.dropwizard.cli.ConfiguredCommand

addFileArgument, cleanup, cleanupAsynchronously, getConfiguration, run

Methods inherited from class io.dropwizard.cli.Command

getDescription, getName, onError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLiquibaseCommand

protected AbstractLiquibaseCommand(String name,
                                   String description,
                                   DatabaseConfiguration<T> strategy,
                                   Class<T> configurationClass,
                                   String migrationsFileName)

Method Detail

getConfigurationClass

protected Class<T> getConfigurationClass()

Description copied from class: ConfiguredCommand

Returns the Class of the configuration type.

Overrides:

getConfigurationClass in class ConfiguredCommand<T extends Configuration>

Returns:

the Class of the configuration type

configure

public void configure(net.sourceforge.argparse4j.inf.Subparser subparser)

Description copied from class: ConfiguredCommand

Configure the command's Subparser.

N.B.: if you override this method, you must call super.override(subparser) in order to preserve the configuration file parameter in the subparser.

Overrides:

configure in class ConfiguredCommand<T extends Configuration>

Parameters:

subparser - the Subparser specific to the command

run

protected void run(@Nullable
                   Bootstrap<T> bootstrap,
                   net.sourceforge.argparse4j.inf.Namespace namespace,
                   T configuration)
            throws Exception

Description copied from class: ConfiguredCommand

Runs the command with the given Bootstrap and Configuration.

Specified by:

run in class ConfiguredCommand<T extends Configuration>

Parameters:

bootstrap - the bootstrap bootstrap

namespace - the parsed command line namespace

configuration - the configuration object

Throws:

Exception - if something goes wrong

run

protected abstract void run(net.sourceforge.argparse4j.inf.Namespace namespace,
                            liquibase.Liquibase liquibase)
                     throws Exception

Throws:

Exception