org.digitalmediaserver.crowdin

Class PushCrowdinMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.digitalmediaserver.crowdin.AbstractCrowdinMojo

org.digitalmediaserver.crowdin.PushCrowdinMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class PushCrowdinMojo
extends AbstractCrowdinMojo

Uploads the base/root language file(s) to Crowdin for translation.

Is defined by the goal name:

push

Field Summary

Fields

Modifier and Type	Field and Description
protected String	confirm This parameter must be true for push to execute.
protected int	escapeQuotes The default "escape_quotes" parameter to use.
protected String	projectName This parameter must match the POM name of the current project in is used to prevent pushing from the wrong project.
protected UpdateOption	updateOption The default update behavior for updates string when pushing.

Fields inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

client, comment, crowdinServerId, downloadFolder, downloadFolderPath, lineSeparator, mavenSession, project, rootBranch, server, statusFiles, translationFileSets

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PushCrowdinMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected int	getEscapeQuotes(TranslationFileSet fileSet) Gets the effective "escape_quotes" value from either the TranslationFileSet or the default parameter.
protected UpdateOption	getUpdateOption(TranslationFileSet fileSet) Gets the effective "update_option" value from either the TranslationFileSet or the default parameter.
protected void	initializeParameters() Initializes the Mojo parameters since they are set via reflection and can't be handled in the constructor.

Methods inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

cleanDownloadFolder, createClient, getBranch, getBranch, initializeServer, isBlank, setClient, setComment, setCrowdinServerId, setDownloadFolder, setDownloadFolder, setLineSeparator, setProject, setRootBranch, setServer, setStatusFiles, setTranslationFileSets

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

Field Detail

projectName

protected String projectName

This parameter must match the POM name of the current project in is used to prevent pushing from the wrong project.

Is defined by:

Is required.

confirm

protected String confirm

This parameter must be true for push to execute. If this isn't specified in the POM file, -Dconfirm=true is required as a command line argument for the push to execute.

Is defined by:

property:

confirm

Is required.

escapeQuotes

protected int escapeQuotes

The default "escape_quotes" parameter to use. Valid values are:

• 0 — Do not escape single quote
• 1 — Escape single quote by another single quote
• 2 — Escape single quote by backslash
• 3 — Escape single quote by another single quote only in strings containing variables ({0})

Is defined by:

default-value:

0

updateOption

protected UpdateOption updateOption

The default update behavior for updates string when pushing. Valid values are:

• delete_translations — Delete translations of changed strings
• update_as_unapproved — Preserve translations of changed strings but remove validations of those translations if they exist
• update_without_changes — Preserve translations and validations of changed strings

Is defined by:

default-value:

delete_translations

Constructor Detail

PushCrowdinMojo

public PushCrowdinMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getEscapeQuotes

protected int getEscapeQuotes(TranslationFileSet fileSet)

Gets the effective "escape_quotes" value from either the TranslationFileSet or the default parameter.

Parameters:

fileSet - the TranslationFileSet to use.

Returns:

The effective "escape_quotes" value.

getUpdateOption

protected UpdateOption getUpdateOption(TranslationFileSet fileSet)

Gets the effective "update_option" value from either the TranslationFileSet or the default parameter.

Parameters:

fileSet - the TranslationFileSet to use.

Returns:

The effective "update_option" value.

initializeParameters

protected void initializeParameters()
                             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractCrowdinMojo

Initializes the Mojo parameters since they are set via reflection and can't be handled in the constructor.

Overrides:

initializeParameters in class AbstractCrowdinMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during initialization.