org.zanata.client.commands

Interface PushPullOptions

All Superinterfaces:

BasicOptions, ConfigurableOptions, ConfigurableProjectOptions

All Known Subinterfaces:

PullOptions, PushOptions

public interface PushPullOptions
extends ConfigurableProjectOptions

Author:

Sean Flanigan sflaniga@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAllModules()
String	getCurrentModule()
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	getModuleSuffix() Character or characters which must appear after moduleIDs when constructing qualified document names
File	getSrcDir()
File	getTransDir()
boolean	isDryRun()
boolean	isRootModule()

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

getLocaleMapList, getProj, getProjectConfig, getProjectType, getProjectVersion, setLocaleMapList, setProj, setProjectConfig, setProjectType, setProjectVersion

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

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

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

getCommandDescription, getCommandName, getDebug, getErrors, getHelp, getQuiet, initCommand, isDebugSet, isErrorsSet, isInteractiveMode, isQuietSet, 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()

getTransDir

File getTransDir()

getEnableModules

boolean getEnableModules()

isRootModule

boolean isRootModule()

getCurrentModule

String getCurrentModule()

getAllModules

Set<String> getAllModules()