co.codewizards.cloudstore.client

Class SubCommand

java.lang.Object

co.codewizards.cloudstore.client.SubCommand

Direct Known Subclasses:

AfterUpdateHookSubCommand, ChangeLdapPasswordSubCommand, CreateRepoSubCommand, DropRepoAliasSubCommand, HelpSubCommand, RepoListSubCommand, SubCommandWithExistingLocalRepo, VersionSubCommand

public abstract class SubCommand
extends Object

Sub-command for a certain CLI operation.

The CloudStore-command-line-interface uses a syntax similar to the svn command and the logic of the command 'java -jar co.codewizards.cloudstore.client-VERSION.jar SUBCOMMAND -arg1 val1 -arg2 val2 ...' is thus actually implemented by a class extending this class and registering for a certain 'SUBCOMMAND'.

Every subclass of this class can declare its arguments using annotations like Option.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at nightlabs dot de

Constructor Summary

Constructors

Constructor and Description
SubCommand()

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Invoked after run().
LocalServerRestClient	getLocalServerRestClient()
abstract String	getSubCommandDescription() Get the description for this sub-command.
String	getSubCommandName() Get the name of the sub-command, i.e.
boolean	isVisibleInHelp()
void	prepare() Invoked before run().
protected String	prompt(String fmt, Object... args)
protected String	promptPassword(String fmt, Object... args)
abstract void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubCommand

public SubCommand()

Method Detail

getSubCommandName

public String getSubCommandName()

Get the name of the sub-command, i.e. what the user has to write in the command line.

Returns:

the name of the sub-command.

getSubCommandDescription

public abstract String getSubCommandDescription()

Get the description for this sub-command.

Returns:

the description.

prepare

public void prepare()
             throws Exception

Invoked before run().

Implementors should always invoked the super-method when overriding!

Throws:

Exception - in case, the preparation failed.

See Also:

cleanUp()

run

public abstract void run()
                  throws Exception

Throws:

Exception

cleanUp

public void cleanUp()
             throws Exception

Invoked after run().

This method is always invoked, when prepare() was invoked - even if run() failed with an exception.

Implementors should always invoked the super-method when overriding (preferably at the end)!

Throws:

Exception - in case, cleaning up failed.

See Also:

prepare()

promptPassword

protected String promptPassword(String fmt,
                                Object... args)

prompt

protected String prompt(String fmt,
                        Object... args)

isVisibleInHelp

public boolean isVisibleInHelp()

getLocalServerRestClient

public LocalServerRestClient getLocalServerRestClient()