org.zanata.client.commands.pull

Class PullOptionsImpl

java.lang.Object

org.zanata.client.commands.BasicOptionsImpl

org.zanata.client.commands.ConfigurableOptionsImpl

org.zanata.client.commands.ConfigurableProjectOptionsImpl

org.zanata.client.commands.AbstractPushPullOptionsImpl<PullOptions>

org.zanata.client.commands.pull.PullOptionsImpl

All Implemented Interfaces:

BasicOptions, ConfigurableOptions, ConfigurableProjectOptions, PullOptions, PushPullOptions

public class PullOptionsImpl
extends AbstractPushPullOptionsImpl<PullOptions>
implements PullOptions

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields inherited from class org.zanata.client.commands.AbstractPushPullOptionsImpl

locales, PROJECT_TYPE_FILE

Constructor Summary

Constructors

Constructor and Description
PullOptionsImpl()

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.
boolean	getCreateSkeletons()
boolean	getEncodeTabs()
boolean	getIncludeFuzzy()
int	getMinDocPercent()
PushPullType	getPullType()
boolean	getPurgeCache()
boolean	getUseCache()
ZanataCommand	initCommand()
boolean	isAuthRequired() Use to disable check for presence of username and API key before running command.
boolean	isContinueAfterError()
void	setContinueAfterError(boolean continueAfterError)
void	setCreateSkeletons(boolean createSkeletons)
void	setEncodeTabs(boolean encodeTabs)
void	setIncludeFuzzy(boolean includeFuzzy)
void	setLocales(String locales)
void	setMinDocPercent(int minDocPercent)
void	setPullType(String pullType)
void	setPurgeCache(boolean purgeCache)
void	setUseCache(boolean useCache)

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

buildFromDocArgument, getAllModules, getCurrentModule, getCurrentModule, getDocNameRegex, getEnableModules, getFromDoc, getLocaleMapList, getModuleSuffix, getSrcDirParameterName, isDryRun, isRootModule, setDryRun, setFromDoc

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

getExcludes, getFileMappingRules, getIncludes, 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.PushPullOptions

buildFromDocArgument, getAllModules, getCurrentModule, getCurrentModule, getDocNameRegex, getEnableModules, getFromDoc, getModuleSuffix, getSrcDir, getSrcDirParameterName, getTransDir, isDryRun, isRootModule

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

getExcludes, getFileMappingRules, getIncludes, getLocaleMapList, getProj, getProjectConfig, getProjectType, getProjectVersion, 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

PullOptionsImpl

public PullOptionsImpl()

Method Detail

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:

setLocales

public void setLocales(String locales)

getPullType

public PushPullType getPullType()

Specified by:

getPullType in interface PullOptions

setPullType

public void setPullType(String pullType)

getCreateSkeletons

public boolean getCreateSkeletons()

Specified by:

getCreateSkeletons in interface PullOptions

setCreateSkeletons

public void setCreateSkeletons(boolean createSkeletons)

getEncodeTabs

public boolean getEncodeTabs()

Specified by:

getEncodeTabs in interface PullOptions

setEncodeTabs

public void setEncodeTabs(boolean encodeTabs)

getIncludeFuzzy

public boolean getIncludeFuzzy()

Specified by:

getIncludeFuzzy in interface PullOptions

setIncludeFuzzy

public void setIncludeFuzzy(boolean includeFuzzy)

getPurgeCache

public boolean getPurgeCache()

Specified by:

getPurgeCache in interface PullOptions

getUseCache

public boolean getUseCache()

Specified by:

getUseCache in interface PullOptions

setContinueAfterError

public void setContinueAfterError(boolean continueAfterError)

isContinueAfterError

public boolean isContinueAfterError()

Specified by:

isContinueAfterError in interface PullOptions

getMinDocPercent

public int getMinDocPercent()

Specified by:

getMinDocPercent in interface PullOptions

setMinDocPercent

public void setMinDocPercent(int minDocPercent)

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.

setUseCache

public void setUseCache(boolean useCache)

setPurgeCache

public void setPurgeCache(boolean purgeCache)