Package io.dropwizard.core.cli

Class EnvironmentCommand<T extends Configuration>

java.lang.Object

io.dropwizard.core.cli.Command

io.dropwizard.core.cli.ConfiguredCommand<T>

io.dropwizard.core.cli.EnvironmentCommand<T>

Type Parameters:

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

Direct Known Subclasses:

ServerCommand

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

A command which executes with a configured Environment.

See Also:

• Configuration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnvironmentCommand(Application<T> application, String name, String description)	Creates a new environment command.

Method Summary

Modifier and Type	Method	Description
@Nullable Environment	getEnvironment()	Returns the constructed environment or null if it hasn't been constructed yet.
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(Environment environment, net.sourceforge.argparse4j.inf.Namespace namespace, T configuration)	Runs the command with the given Environment and Configuration.

Methods inherited from class io.dropwizard.core.cli.ConfiguredCommand

addFileArgument, cleanup, cleanupAsynchronously, configure, getConfiguration, getConfigurationClass, run

Methods inherited from class io.dropwizard.core.cli.Command

getDescription, getName, onError

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentCommand

protected EnvironmentCommand(Application<T> application,
 String name,
 String description)

Creates a new environment command.

Parameters:

application - the application providing this command

name - the name of the command, used for command line invocation

description - a description of the command's purpose

Method Details

getEnvironment

public @Nullable Environment getEnvironment()

Returns the constructed environment or null if it hasn't been constructed yet.

Returns:

Returns the constructed environment or null if it hasn't been constructed yet

Since:

2.0.19

run

protected void run(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

namespace - the parsed command line namespace

configuration - the configuration object

Throws:

Exception - if something goes wrong

run

protected abstract void run(Environment environment,
 net.sourceforge.argparse4j.inf.Namespace namespace,
 T configuration)
                     throws Exception

Runs the command with the given Environment and Configuration.

Parameters:

environment - the configured environment

namespace - the parsed command line namespace

configuration - the configuration object

Throws:

Exception - if something goes wrong