org.digitalmediaserver.crowdin

Class PullCrowdinMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.digitalmediaserver.crowdin.AbstractCrowdinMojo

org.digitalmediaserver.crowdin.PullCrowdinMojo

All Implemented Interfaces:

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

@Mojo(name="pull",
      defaultPhase=NONE)
public class PullCrowdinMojo
extends AbstractCrowdinMojo

Executes FetchCrowdinMojo and DeployCrowdinMojo in that order. This effectively builds and downloads the latest translations from Crowdin and then deploys them to the local project.

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	buildTimeout The number of seconds to wait for builds to complete
protected boolean	exportApprovedOnly Only texts that are both translated and approved will be included in the exported translation files.
protected boolean	skipUntranslatedFiles Only translated files will be included in the exported translation files.
protected boolean	skipUntranslatedStrings Only translated strings will be included in the exported translation files.

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
PullCrowdinMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected void	initializeServer() Initializes AbstractCrowdinMojo.server by retrieving the appropriate Server instance from the Maven settings and validating its settings.

Methods inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

cleanDownloadFolder, createClient, getBranch, getBranch, getPluginVersion, initializeParameters, 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

skipUntranslatedStrings

@Parameter(property="skipUntranslatedStrings",
           defaultValue="true")
protected boolean skipUntranslatedStrings

Only translated strings will be included in the exported translation files. This option is not applied to text documents: *.docx, *.pptx, *.xlsx, etc., since missing texts may cause the resulting files to be unreadable.

Note: This parameter cannot be true if skipUntranslatedFiles is true.

skipUntranslatedFiles

@Parameter(property="skipUntranslatedFiles",
           defaultValue="false")
protected boolean skipUntranslatedFiles

Only translated files will be included in the exported translation files.

Note: This parameter cannot be true if skipUntranslatedStrings is true.

exportApprovedOnly

@Parameter(property="exportApprovedOnly",
           defaultValue="false")
protected boolean exportApprovedOnly

Only texts that are both translated and approved will be included in the exported translation files. This will require additional efforts from your proofreaders to approve all suggestions.

buildTimeout

@Parameter(property="buildTimeouot",
           defaultValue="60")
protected Integer buildTimeout

The number of seconds to wait for builds to complete

Constructor Detail

PullCrowdinMojo

public PullCrowdinMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

initializeServer

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

Description copied from class: AbstractCrowdinMojo

Initializes AbstractCrowdinMojo.server by retrieving the appropriate Server instance from the Maven settings and validating its settings.

Overrides:

initializeServer in class AbstractCrowdinMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - If a required parameter is missing or the specified crowdinServerId isn't configured.