org.zanata.client.commands
Interface BasicOptions

All Known Subinterfaces:

ConfigurableOptions, ConfigurableProjectOptions, GetStatisticsOptions, GlossaryDeleteOptions, GlossaryPushOptions, PublicanPullOptions, PublicanPushOptions, PullOptions, PushOptions, PushPullOptions, PutProjectOptions, PutUserOptions, PutVersionOptions

All Known Implementing Classes:

AbstractPushPullOptionsImpl, BasicOptionsImpl, ConfigurableOptionsImpl, ConfigurableProjectOptionsImpl, GetStatisticsOptionsImpl, ListLocalOptionsImpl, ListRemoteOptionsImpl, PublicanPullOptionsImpl, PublicanPushOptionsImpl, PullOptionsImpl, PushOptionsImpl, PutProjectOptionsImpl, PutUserOptionsImpl, PutVersionOptionsImpl

public interface BasicOptions

Method Summary

String	getCommandDescription() Used to generate CLI usage help.
String	getCommandName() Used to generate the command line interface and its usage help.
boolean	getDebug() Whether to enable debug mode.
boolean	getErrors() Whether to display full information about errors (ie exception stack traces).
boolean	getHelp() Whether to display the command's usage help.
boolean	getQuiet() Enable quiet mode - error messages only
ZanataCommand	initCommand()
boolean	isDebugSet()
boolean	isErrorsSet()
boolean	isInteractiveMode()
boolean	isQuietSet()
void	setDebug(boolean debug)
void	setErrors(boolean errors)
void	setHelp(boolean help)
void	setInteractiveMode(boolean interactiveMode)
void	setQuiet(boolean quiet)

Method Detail

initCommand

ZanataCommand initCommand()

getDebug

boolean getDebug()

Whether to enable debug mode. Defaults to the value in zanata.ini. This value is used by command line clients, but not by Maven (which uses its own --debug/-X flag).

setDebug

void setDebug(boolean debug)

isDebugSet

boolean isDebugSet()

getErrors

boolean getErrors()

Whether to display full information about errors (ie exception stack traces). Defaults to the value in zanata.ini. This value is used by command line clients, but not by Maven (which uses its own --errors/-e flag).

setErrors

void setErrors(boolean errors)

isErrorsSet

boolean isErrorsSet()

getHelp

boolean getHelp()

Whether to display the command's usage help. Maven uses the auto-generated HelpMojo instead.

setHelp

void setHelp(boolean help)

getQuiet

boolean getQuiet()

Enable quiet mode - error messages only

setQuiet

void setQuiet(boolean quiet)

isQuietSet

boolean isQuietSet()

isInteractiveMode

boolean isInteractiveMode()

setInteractiveMode

void setInteractiveMode(boolean interactiveMode)

getCommandName

String getCommandName()

Used to generate the command line interface and its usage help. This name should match the Maven Mojo's 'goal' annotation and must match the @SubCommand name in ZanataClient.

Returns:

getCommandDescription

String getCommandDescription()

Used to generate CLI usage help. This description should preferably match the Maven Mojo's Javadoc description.

Returns: