org.zanata.maven

Class AbstractPushPullMojo<O extends PushPullOptions>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.zanata.maven.ConfigurableMojo<O>

org.zanata.maven.ConfigurableProjectMojo<O>

org.zanata.maven.AbstractPushPullMojo<O>

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, BasicOptions, ConfigurableOptions, ConfigurableProjectOptions, PushPullOptions

Direct Known Subclasses:

AbstractPullMojo, AbstractPushMojo

public abstract class AbstractPushPullMojo<O extends PushPullOptions>
extends ConfigurableProjectMojo<O>
implements PushPullOptions

Author:

Sean Flanigan

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PROJECT_TYPE_FILE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractPushPullMojo()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildFromDocArgument(String argValue)
Set<String>	getAllModules()
String	getCurrentModule()
String	getCurrentModule(boolean canonicalName)
String	getDocNameRegex()
String	getFromDoc()
LocaleList	getLocaleMapList() Override the default ConfigurableProjectMojo.getLocaleMapList() method as the push command can have locales specified via command line.
String	getModuleSuffix()
File	getSrcDir()
String	getSrcDirParameterName()
File	getTransDir()
boolean	isDryRun()
boolean	isRootModule()
protected void	runCommand()

Methods inherited from class org.zanata.maven.ConfigurableProjectMojo

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

Methods inherited from class org.zanata.maven.ConfigurableMojo

execute, getCommandDescription, getDebug, getErrors, getHelp, getKey, getLogHttp, getQuiet, getUrl, getUserConfig, getUsername, initCommand, isDebugSet, isDisableSSLCert, isErrorsSet, isInteractiveMode, isQuietSet, setDebug, setDisableSSLCert, setErrors, setHelp, setInteractiveMode, setKey, setLogHttp, setQuiet, setUrl, setUserConfig, setUsername

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

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

getEnableModules

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

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

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

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

Field Detail

PROJECT_TYPE_FILE

protected static final String PROJECT_TYPE_FILE

See Also:

Constant Field Values

Constructor Detail

AbstractPushPullMojo

public AbstractPushPullMojo()

Method Detail

runCommand

protected void runCommand()
                   throws Exception

Overrides:

runCommand in class ConfigurableMojo<O extends PushPullOptions>

Throws:

Exception

isRootModule

public boolean isRootModule()

Specified by:

isRootModule in interface PushPullOptions

getCurrentModule

public String getCurrentModule()

Specified by:

getCurrentModule in interface PushPullOptions

getCurrentModule

public String getCurrentModule(boolean canonicalName)

Specified by:

getCurrentModule in interface PushPullOptions

getModuleSuffix

public String getModuleSuffix()

Specified by:

getModuleSuffix in interface PushPullOptions

getDocNameRegex

public String getDocNameRegex()

Specified by:

getDocNameRegex in interface PushPullOptions

getAllModules

public Set<String> getAllModules()

Specified by:

getAllModules in interface PushPullOptions

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface PushPullOptions

Returns:

the dryRun

getSrcDir

public File getSrcDir()

Specified by:

getSrcDir in interface PushPullOptions

getSrcDirParameterName

public String getSrcDirParameterName()

Specified by:

getSrcDirParameterName in interface PushPullOptions

getTransDir

public File getTransDir()

Specified by:

getTransDir in interface PushPullOptions

getFromDoc

public String getFromDoc()

Specified by:

getFromDoc in interface PushPullOptions

buildFromDocArgument

public String buildFromDocArgument(String argValue)

Specified by:

buildFromDocArgument in interface PushPullOptions

getLocaleMapList

public LocaleList getLocaleMapList()

Override the default ConfigurableProjectMojo.getLocaleMapList() method as the push command can have locales specified via command line.

Specified by:

getLocaleMapList in interface ConfigurableProjectOptions

Overrides:

getLocaleMapList in class ConfigurableProjectMojo<O extends PushPullOptions>

Returns:

The locale map list taking into account the global locales in zanata.xml as well as the command line argument ones.