Package io.dropwizard.cli

Class CheckCommand<T extends Configuration>

java.lang.Object

io.dropwizard.cli.Command

io.dropwizard.cli.ConfiguredCommand<T>

io.dropwizard.cli.CheckCommand<T>

Type Parameters:

T - the Configuration subclass which is loaded from the configuration file

public class CheckCommand<T extends Configuration>
extends ConfiguredCommand<T>

Parses and validates the application's configuration.

Constructor Summary

Constructors

Constructor	Description
CheckCommand(Application<T> application)

Method Summary

Modifier and Type	Method	Description
protected java.lang.Class<T>	getConfigurationClass()	Returns the Class of the configuration type.
void	onError(Cli cli, net.sourceforge.argparse4j.inf.Namespace namespace, java.lang.Throwable e)	Method is called if there is an issue parsing configuration, setting up the environment, or running the command itself.
protected void	run(Bootstrap<T> bootstrap, net.sourceforge.argparse4j.inf.Namespace namespace, T configuration)	Runs the command with the given Bootstrap and Configuration.

Methods inherited from class io.dropwizard.cli.Command

getDescription, getName

Methods inherited from class io.dropwizard.cli.ConfiguredCommand

addFileArgument, cleanup, cleanupAsynchronously, configure, run

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckCommand

public CheckCommand(Application<T> application)

Method Detail

getConfigurationClass

protected java.lang.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

run

protected void run(Bootstrap<T> bootstrap,
                   net.sourceforge.argparse4j.inf.Namespace namespace,
                   T configuration)
            throws java.lang.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:

java.lang.Exception - if something goes wrong

onError

public void onError(Cli cli,
                    net.sourceforge.argparse4j.inf.Namespace namespace,
                    java.lang.Throwable e)

Description copied from class: Command

Method is called if there is an issue parsing configuration, setting up the environment, or running the command itself. The default is printing the stacktrace to facilitate debugging, but can be customized per command.

Overrides:

onError in class Command

Parameters:

cli - contains the streams for stdout and stderr

namespace - the parsed arguments from the commandline

e - The exception that was thrown when setting up or running the command