org.digitalmediaserver.crowdin.configuration

Class TranslationFileSet

java.lang.Object

org.digitalmediaserver.crowdin.configuration.AbstractFileSet

org.digitalmediaserver.crowdin.configuration.TranslationFileSet

public class TranslationFileSet
extends AbstractFileSet

A Mojo configuration class describing a set of translation files.

Author:

Nadahar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseFileName The base language file that should be uploaded to Crowdin.
protected String	commentTag The comment character or character combination to use for comment lines when exporting files from Crowdin if addComment is true.
protected String	crowdinPath The path from the Crowdin (branch) root folder to the files of this TranslationFileSet.
protected Integer	escapeQuotes The escape_quotes API parameter to use.
protected List<String>	excludes Paths to exclude using a basic filter where ?
protected String	fileNameWhenExported The value to use in the "Resulting file name when exported" setting at Crowdin.
protected List<String>	includes Paths to include using a basic filter where ?
protected File	languageFilesFolder The folder where the language files are located.
protected String	targetFileName The file path relative to languageFilesFolder to use when deploying the translation files.
protected String	title The title as it should appear to translators at Crowdin.
protected UpdateOption	updateOption The update behavior for updates string when pushing.

Fields inherited from class org.digitalmediaserver.crowdin.configuration.AbstractFileSet

addComment, charset, comment, conversions, encoding, escapeUnicode, lineSeparator, sortLines, type

Constructor Summary

Constructors

Constructor and Description
TranslationFileSet()

Method Summary

Methods

Modifier and Type	Method and Description
String	getBaseFileName()
String	getCommentTag()
String	getCrowdinPath()
Integer	getEscapeQuotes()
List<String>	getExcludes()
String	getFileNameWhenExported()
List<String>	getIncludes()
File	getLanguageFilesFolder()
String	getTargetFileName()
String	getTitle()
UpdateOption	getUpdateOption()
protected void	initializeInstance() Since the constructor is called automagically by Maven, verification and initialization of defaults is done here.
void	setCommentTag(String commentTag) Sets the comment tag.
String	toString()

Methods inherited from class org.digitalmediaserver.crowdin.configuration.AbstractFileSet

getAddComment, getCharset, getComment, getConversions, getEncoding, getEscapeUnicode, getLineSeparator, getSortLines, getType, initialize, setCharset, setEncoding, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

languageFilesFolder

protected File languageFilesFolder

The folder where the language files are located.

Is defined by:

Is required.

crowdinPath

protected String crowdinPath

The path from the Crowdin (branch) root folder to the files of this TranslationFileSet. Only specify it the files are located in a subfolder at Crowdin.

Is defined by:

baseFileName

protected String baseFileName

The base language file that should be uploaded to Crowdin.

Is defined by:

Is required.

title

protected String title

The title as it should appear to translators at Crowdin.

Is defined by:

commentTag

protected String commentTag

The comment character or character combination to use for comment lines when exporting files from Crowdin if addComment is true.

Is defined by:

default-value:

#

fileNameWhenExported

protected String fileNameWhenExported

The value to use in the "Resulting file name when exported" setting at Crowdin.

The following variables are available:

• %language% – Language name (e.g. Ukrainian)
• %two_letters_code% – Language code ISO 639-1 (i.e. uk)
• %three_letters_code% – Language code ISO 639-2/T (i.e. ukr)
• %locale% – Locale (like uk-UA)
• %locale_with_underscore% – Locale (i.e. uk_UA)
• %android_code% – Android Locale identifier used to name "values-" directories
• %osx_code% – macOS Locale identifier used to name ".lproj" directories
• %osx_locale% – macOS Locale used to name translated resources (i.e. uk, zh_Hans)
• %original_file_name% – Original file name
• %file_name% – File name without extension
• %file_extension% – Original file extension
• %original_path% – Use parent folders' names in your project to build the file path in the resulting archive

Is defined by:

Is required.

targetFileName

@Nullable
protected String targetFileName

The file path relative to languageFilesFolder to use when deploying the translation files. If left blank, fileNameWhenExported will be used.

The following variables are available:

• %crowdin_code% – Crowdin language code (i.e en-GB or da)
• %crowdin_code_with_underscore% – Crowdin language code with underscore (i.e en_GB or da)
• %shortest_iso639_code% – The shortest ISO 639 language code (i.e en or ceb)
• %language% – Language name (e.g. Ukrainian)
• %two_letters_code% – Language code ISO 639-1 (i.e. uk)
• %three_letters_code% – Language code ISO 639-2/T (i.e. ukr)
• %locale% – Locale (like uk-UA) (*)
• %locale_with_underscore% – Locale (i.e. uk_UA) (*)
• %android_code% – Android Locale identifier used to name "values-" directories (*)
• %osx_code% – macOS Locale identifier used to name ".lproj" directories (*)
• %osx_locale% – macOS Locale used to name translated resources (i.e. uk, zh_Hans) (*)
• %original_file_name% – Original file name (*)
• %file_name% – File name without extension (*)
• %file_extension% – Original file extension (*)
• %original_path% – Use parent folders' names in your project to build the file path in the resulting archive (*)

(*) The variable must also be used in fileNameWhenExported to be supported.

Is defined by:

escapeQuotes

@Nullable
protected Integer escapeQuotes

The escape_quotes API 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:

updateOption

protected UpdateOption updateOption

The 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

includes

@Nullable
protected List<String> includes

Paths to include using a basic filter where ? and * are wildcards and the rest are literals. If one or more includes are configured the file set becomes a white-list where anything not included is excluded.

Is defined by:

excludes

@Nullable
protected List<String> excludes

Paths to exclude using a basic filter where ? and * are wildcards and the rest are literals.

Is defined by:

Constructor Detail

TranslationFileSet

public TranslationFileSet()

Method Detail

getCommentTag

public String getCommentTag()

Returns:

The comment tag.

setCommentTag

public void setCommentTag(String commentTag)

Sets the comment tag.

Parameters:

commentTag - the comment tag to set.

getLanguageFilesFolder

public File getLanguageFilesFolder()

Returns:

The language files folder.

getCrowdinPath

public String getCrowdinPath()

Returns:

The path from the Crowdin (branch) root folder to the files of this TranslationFileSet or null it the files are in the root of the Crowdin (branch) file structure.

getBaseFileName

public String getBaseFileName()

Returns:

The base filename.

getTitle

public String getTitle()

Returns:

The title.

getFileNameWhenExported

@Nonnull
public String getFileNameWhenExported()

Returns:

The "Resulting file name when exported" to use on Crowdin.

getTargetFileName

@Nullable
public String getTargetFileName()

Returns:

The file path relative to languageFilesFolder to use when deploying translation files. If left blank, fileNameWhenExported will be used.

getEscapeQuotes

@Nullable
public Integer getEscapeQuotes()

Returns:

The escape_quotes API parameter.

getUpdateOption

public UpdateOption getUpdateOption()

Returns:

The UpdateOption.

getIncludes

@Nullable
public List<String> getIncludes()

Returns:

The List of string patterns for paths to include. The patterns use a basic filter where ? and * are wildcards and the rest are literals. If one or more inclusions are configured the file set becomes a white-list where anything not included is excluded.

getExcludes

@Nullable
public List<String> getExcludes()

Returns:

The List of string patterns for paths to exclude. The patterns use a basic filter where ? and * are wildcards and the rest are literals.

toString

public String toString()

Overrides:

toString in class Object

initializeInstance

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

Description copied from class: AbstractFileSet

Since the constructor is called automagically by Maven, verification and initialization of defaults is done here.

Overrides:

initializeInstance in class AbstractFileSet

Throws:

org.apache.maven.plugin.MojoExecutionException - If the initialization fails.