org.zanata.client.commands.stats

Class GetStatisticsOptionsImpl

java.lang.Object

org.zanata.client.commands.BasicOptionsImpl

org.zanata.client.commands.ConfigurableOptionsImpl

org.zanata.client.commands.ConfigurableProjectOptionsImpl

org.zanata.client.commands.stats.GetStatisticsOptionsImpl

All Implemented Interfaces:

BasicOptions, ConfigurableOptions, ConfigurableProjectOptions, GetStatisticsOptions

public class GetStatisticsOptionsImpl
extends ConfigurableProjectOptionsImpl
implements GetStatisticsOptions

Author:

Carlos Munoz camunoz@redhat.com

Constructor Summary

Constructors

Constructor and Description
GetStatisticsOptionsImpl()

Method Summary

Modifier and Type	Method and Description
String	getCommandDescription() Used to generate CLI usage help.
String	getCommandName() Used to generate the command line interface and its usage help.
String	getDocumentId()
String	getFormat()
boolean	getIncludeDetails()
boolean	getIncludeWordLevelStats()
ZanataCommand	initCommand()
boolean	isAuthRequired() Use to disable check for presence of username and API key before running command.
void	setDocumentId(String documentId)
void	setFormat(String format)
void	setIncludeDetails(boolean includeDetails)
void	setIncludeWordLevelStats(boolean includeWordLevelStats)

Methods inherited from class org.zanata.client.commands.ConfigurableProjectOptionsImpl

getExcludes, getFileMappingRules, getIncludes, getLocaleMapList, getProj, getProjectConfig, getProjectType, getProjectVersion, getSrcDir, getTransDir, setExcludes, setFileMappingRules, setIncludes, setLocaleMapList, setProj, setProjectConfig, setProjectType, setProjectVersion, setSrcDir, setTransDir

Methods inherited from class org.zanata.client.commands.ConfigurableOptionsImpl

getKey, getLogHttp, getUrl, getUserConfig, getUsername, isDisableSSLCert, setDisableSSLCert, setKey, setLogHttp, setUrl, setUserConfig, setUsername

Methods inherited from class org.zanata.client.commands.BasicOptionsImpl

getCommandHooks, getDebug, getErrors, getHelp, getQuiet, isDebugSet, isErrorsSet, isInteractiveMode, isQuietSet, setBatchMode, setCommandHooks, setDebug, setErrors, setHelp, setInteractiveMode, setQuiet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zanata.client.commands.ConfigurableProjectOptions

getExcludes, getFileMappingRules, getIncludes, getLocaleMapList, getProj, getProjectConfig, getProjectType, getProjectVersion, getSrcDir, getTransDir, setExcludes, setFileMappingRules, setIncludes, setLocaleMapList, setProj, setProjectConfig, setProjectType, setProjectVersion, setSrcDir, setTransDir

Methods inherited from interface org.zanata.client.commands.ConfigurableOptions

getKey, getLogHttp, getUrl, getUserConfig, getUsername, isDisableSSLCert, setDisableSSLCert, setKey, setLogHttp, setUrl, setUserConfig, setUsername

Methods inherited from interface org.zanata.client.commands.BasicOptions

getCommandHooks, getDebug, getErrors, getHelp, getQuiet, isDebugSet, isErrorsSet, isInteractiveMode, isQuietSet, setCommandHooks, setDebug, setErrors, setHelp, setInteractiveMode, setQuiet

Constructor Detail

GetStatisticsOptionsImpl

public GetStatisticsOptionsImpl()

Method Detail

getIncludeDetails

public boolean getIncludeDetails()

Specified by:

getIncludeDetails in interface GetStatisticsOptions

setIncludeDetails

public void setIncludeDetails(boolean includeDetails)

Specified by:

setIncludeDetails in interface GetStatisticsOptions

getIncludeWordLevelStats

public boolean getIncludeWordLevelStats()

Specified by:

getIncludeWordLevelStats in interface GetStatisticsOptions

setIncludeWordLevelStats

public void setIncludeWordLevelStats(boolean includeWordLevelStats)

Specified by:

setIncludeWordLevelStats in interface GetStatisticsOptions

getFormat

public String getFormat()

Specified by:

getFormat in interface GetStatisticsOptions

setFormat

public void setFormat(String format)

Specified by:

setFormat in interface GetStatisticsOptions

getDocumentId

public String getDocumentId()

Specified by:

getDocumentId in interface GetStatisticsOptions

setDocumentId

public void setDocumentId(String documentId)

Specified by:

setDocumentId in interface GetStatisticsOptions

initCommand

public ZanataCommand initCommand()

Specified by:

initCommand in interface BasicOptions

getCommandName

public String getCommandName()

Description copied from interface: BasicOptions

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.

Specified by:

getCommandName in interface BasicOptions

Returns:

getCommandDescription

public String getCommandDescription()

Description copied from interface: BasicOptions

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

Specified by:

getCommandDescription in interface BasicOptions

Returns:

isAuthRequired

public boolean isAuthRequired()

Description copied from interface: ConfigurableOptions

Use to disable check for presence of username and API key before running command.

Specified by:

isAuthRequired in interface ConfigurableOptions

Overrides:

isAuthRequired in class ConfigurableOptionsImpl

Returns:

true if this command should fail when username or API key is absent.