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

@Mojo(name="push",
      defaultPhase=NONE)
public class PushCrowdinMojo
extends AbstractCrowdinMojo

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	confirm This parameter must be true for push to execute.
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 Boolean	replaceModifiedContext The global option of whether to overwrite context when updating source files, even if the context has been modified on Crowdin.
protected UpdateOption	updateOption The default update behavior for updated strings when pushing.

Fields inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

client, comment, crowdinServerId, disableBranches, downloadFolder, downloadFolderPath, gitBaseFolder, httpTimeout, lineSeparator, mavenSession, project, projectId, 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 FileExportOptions	generateExportOptions(TranslationFileSet fileSet, FileInfo templateFile) Builds the "effective" FileExportOptions from a combination of the template file settings (if any) and the TranslationFileSet configuration.
protected Boolean	getReplaceModifiedContext(TranslationFileSet fileSet) Gets the effective "replaceModifiedContext" value from either the TranslationFileSet or the default parameter.
protected UpdateOption	getUpdateOption(TranslationFileSet fileSet) Gets the effective "updateOption" 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, getPluginVersion, initializeServer, setClient, setComment, setCrowdinServerId, setDisableBranches, setDownloadFolder, setDownloadFolder, setGitBaseFolder, setHTTPTimeout, setLineSeparator, setProject, setProjectId, 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

@Parameter(property="projectName",
           required=true)
protected String projectName

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

confirm

@Parameter(property="confirm",
           defaultValue="false")
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.

updateOption

@Parameter(property="updateOption",
           defaultValue="clear_translations_and_approvals")
protected UpdateOption updateOption

The default update behavior for updated strings when pushing. Valid values are:

• clear_translations_and_approvals — Delete translations of changed strings
• keep_translations — Preserve translations of changed strings but remove approvals of those translations if they exist
• keep_translations_and_approvals — Preserve translations and approvals of changed strings

replaceModifiedContext

@Parameter(property="replaceModifiedContext",
           defaultValue="false")
protected Boolean replaceModifiedContext

The global option of whether to overwrite context when updating source files, even if the context has been modified on Crowdin.

Constructor Detail

PushCrowdinMojo

public PushCrowdinMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getUpdateOption

protected UpdateOption getUpdateOption(TranslationFileSet fileSet)

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

Parameters:

fileSet - the TranslationFileSet to use.

Returns:

The effective "updateOption" value.

getReplaceModifiedContext

protected Boolean getReplaceModifiedContext(TranslationFileSet fileSet)

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

Parameters:

fileSet - the TranslationFileSet to use.

Returns:

The effective "replaceModifiedContext" value.

generateExportOptions

protected FileExportOptions generateExportOptions(@Nonnull
                                      TranslationFileSet fileSet,
                                      @Nullable
                                      FileInfo templateFile)
                                           throws org.apache.maven.plugin.MojoExecutionException

Builds the "effective" FileExportOptions from a combination of the template file settings (if any) and the TranslationFileSet configuration.

Parameters:

fileSet - the TranslationFileSet from which to get the configuration.

templateFile - the FileInfo for the template file, if any.

Returns:

the combined/merged FileExportOptions.

Throws:

org.apache.maven.plugin.MojoExecutionException - If validation of the resulting options fails.

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.