org.zanata.client.commands

Interface PushPullOptions

All Superinterfaces:

BasicOptions, ConfigurableOptions, ConfigurableProjectOptions

All Known Subinterfaces:

PullOptions, PushOptions

All Known Implementing Classes:

AbstractPushPullOptionsImpl, PullOptionsImpl, PushOptionsImpl

public interface PushPullOptions
extends ConfigurableProjectOptions

Author:

Sean Flanigan sflaniga@redhat.com

Method Summary

Modifier and Type	Method and Description
String	buildFromDocArgument(String argValue) This name should represent the exact parameter as it would be entered on the command line, and include any space or operators that would link the parameter to the argument.
com.google.common.collect.ImmutableSet<String>	getAllModules()
String	getCurrentModule()
String	getCurrentModule(boolean canonicalName)
String	getDocNameRegex() A regex for document names, which captures the module ID as group 1 and the unqualified docname as group 2.
boolean	getEnableModules()
String	getFromDoc()
String	getModuleSuffix() Character or characters which must appear after moduleIDs when constructing qualified document names
File	getSrcDir()
String	getSrcDirParameterName()
File	getTransDir()
boolean	isDryRun()
boolean	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, isAuthRequired, isDisableSSLCert, setDisableSSLCert, setKey, setLogHttp, setUrl, setUserConfig, setUsername

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

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

Method Detail

getModuleSuffix

String getModuleSuffix()

Character or characters which must appear after moduleIDs when constructing qualified document names

Returns:

getDocNameRegex

String getDocNameRegex()

A regex for document names, which captures the module ID as group 1 and the unqualified docname as group 2. This regex should broadly follow the pattern "(moduleID)moduleSuffix(localDocName)".

isDryRun

boolean isDryRun()

getSrcDir

File getSrcDir()

Specified by:

getSrcDir in interface ConfigurableProjectOptions

getSrcDirParameterName

String getSrcDirParameterName()

getTransDir

File getTransDir()

Specified by:

getTransDir in interface ConfigurableProjectOptions

getFromDoc

String getFromDoc()

buildFromDocArgument

String buildFromDocArgument(String argValue)

This name should represent the exact parameter as it would be entered on the command line, and include any space or operators that would link the parameter to the argument. This is so that the argument can be appended directly to the parameter name.

getEnableModules

boolean getEnableModules()

isRootModule

boolean isRootModule()

getCurrentModule

String getCurrentModule()

getCurrentModule

String getCurrentModule(boolean canonicalName)

Parameters:

canonicalName - true if the module name should be in the canonical format used by maven

Returns:

getAllModules

com.google.common.collect.ImmutableSet<String> getAllModules()