org.zanata.client.commands

Class ConfigurableCommand<O extends ConfigurableOptions>

java.lang.Object

org.zanata.client.commands.ConfigurableCommand<O>

All Implemented Interfaces:

ZanataCommand

Direct Known Subclasses:

ConfigurableProjectCommand, GetStatisticsCommand, GlossaryDeleteCommand, GlossaryPushCommand, InitCommand, PutProjectCommand, PutUserCommand, PutVersionCommand

public abstract class ConfigurableCommand<O extends ConfigurableOptions>
extends Object
implements ZanataCommand

Base class for commands which supports configuration by the user's zanata.ini

Author:

Sean Flanigan

Constructor Summary

Constructors

Constructor and Description
ConfigurableCommand(O opts)
ConfigurableCommand(O opts, RestClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
void	deprecate(String deprecationMessage)
protected static void	expectYes(Console console) Deprecated.
RestClientFactory	getClientFactory()
String	getDeprecationMessage() If the command has been deprecated, returns a message (eg a command which replaces the deprecated command).
String	getName() Returns the command name (eg Maven goal name)
O	getOpts()
boolean	isDeprecated() Returns true if the command has been deprecated.
protected abstract void	run() Runs the specific command, not including before- or after- actions.
void	runWithActions() Executes before-actions, the command, then after-actions.
protected void	setClientFactory(RestClientFactory clientFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableCommand

public ConfigurableCommand(O opts,
                           RestClientFactory clientFactory)

ConfigurableCommand

public ConfigurableCommand(O opts)

Method Detail

expectYes

@Deprecated
protected static void expectYes(Console console)
                                     throws IOException

Deprecated.

Throws:

IOException

getOpts

public O getOpts()

getClientFactory

public RestClientFactory getClientFactory()

setClientFactory

protected final void setClientFactory(RestClientFactory clientFactory)

isDeprecated

public boolean isDeprecated()

Description copied from interface: ZanataCommand

Returns true if the command has been deprecated.

Specified by:

isDeprecated in interface ZanataCommand

Returns:

getDeprecationMessage

public String getDeprecationMessage()

Description copied from interface: ZanataCommand

If the command has been deprecated, returns a message (eg a command which replaces the deprecated command).

Specified by:

getDeprecationMessage in interface ZanataCommand

Returns:

deprecate

public void deprecate(String deprecationMessage)

getName

public String getName()

Description copied from interface: ZanataCommand

Returns the command name (eg Maven goal name)

Specified by:

getName in interface ZanataCommand

Returns:

runWithActions

public void runWithActions()
                    throws Exception

Description copied from interface: ZanataCommand

Executes before-actions, the command, then after-actions. Before- and after-actions are specified in command hooks, and will be skipped if they are not supported for the command or if none are specified. The command is executed using the parameters which have been previously set. This method must be called after initConfig().

Specified by:

runWithActions in interface ZanataCommand

Throws:

Exception

See Also:

org.zanata.client.config.CommandHook}

run

protected abstract void run()
                     throws Exception

Runs the specific command, not including before- or after- actions.

Throws:

Exception