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 Required.
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 Applies to FileType.properties files only.
protected Integer	escapeSpecialCharacters Applies to FileType.properties files only.
protected List<String>	excludes Paths to exclude using a basic filter where ?
protected String	exportPattern The value to use in the "Resulting file name when exported" setting at Crowdin.
protected FileExportOptions.JavaScriptExportQuotes	exportQuotes Applies to FileType.js files only.
protected List<String>	includes Paths to include using a basic filter where ?
protected File	languageFilesFolder Required.
protected Boolean	replaceModifiedContext Whether or not to overwrite context when updating the source file, even if the context has been modified on Crowdin.
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.
protected Boolean	writeBOM Whether or not to write a BOM (Byte Order Mark) at the beginning of the file when deploying translations files.

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()
Integer	getEscapeSpecialCharacters()
List<String>	getExcludes()
String	getExportPattern()
FileExportOptions.JavaScriptExportQuotes	getExportQuotes()
List<String>	getIncludes()
File	getLanguageFilesFolder()
Boolean	getReplaceModifiedContext()
String	getTargetFileName()
String	getTitle()
UpdateOption	getUpdateOption()
Boolean	getWriteBOM()
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

Required. The folder where the language files are located.

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.

baseFileName

protected String baseFileName

Required. The base language file that should be uploaded to Crowdin.

title

protected String title

The title as it should appear to translators at Crowdin.

commentTag

protected String commentTag

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

exportPattern

protected String exportPattern

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

targetFileName

@Nullable
protected String targetFileName

The file path relative to languageFilesFolder to use when deploying the translation files. If left blank, exportPattern 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 exportPattern to be supported.

escapeQuotes

@Nullable
protected Integer escapeQuotes

Applies to FileType.properties files only.

The escapeQuotes API parameter to use. Valid values are:

• 0 — Do not escape single quote (default)
• 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})

escapeSpecialCharacters

@Nullable
protected Integer escapeSpecialCharacters

Applies to FileType.properties files only.

The escapeSpecialCharacters API parameter to use. It defines whether any special characters (=, :, ! and #) should be escaped by backslash in the exported translations.

Valid values are:

• 0 — Do not escape special characters (default)
• 1 — Escape special characters by a backslash

exportQuotes

@Nullable
protected FileExportOptions.JavaScriptExportQuotes exportQuotes

Applies to FileType.js files only.

The exportQuotes API parameter to use. It defines what type of quotes to use when exporting JavaScript translations.

Valid values are:

• single — Output will be enclosed in single quotes (default)
• double — Output will be enclosed in double quotes

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

replaceModifiedContext

protected Boolean replaceModifiedContext

Whether or not to overwrite context when updating the source file, even if the context has been modified on Crowdin.

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.

excludes

@Nullable
protected List<String> excludes

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

writeBOM

@Nullable
protected Boolean writeBOM

Whether or not to write a BOM (Byte Order Mark) at the beginning of the file when deploying translations files. This is only applicable to Unicode encodings, and generally isn't recommended for UTF-8. Despite this, some systems, like NSIS, requires a UTF-8 BOM to be present to interpret the file as UTF-8. In such cases, set this parameter to true.

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.

getExportPattern

@Nonnull
public String getExportPattern()

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, exportPattern will be used.

getEscapeQuotes

@Nullable
public Integer getEscapeQuotes()

Returns:

The escapeQuotes value.

getExportQuotes

@Nullable
public FileExportOptions.JavaScriptExportQuotes getExportQuotes()

Returns:

The exportQuotes value.

getEscapeSpecialCharacters

@Nullable
public Integer getEscapeSpecialCharacters()

Returns:

The escapeSpecialCharacters value.

getUpdateOption

public UpdateOption getUpdateOption()

Returns:

The UpdateOption.

getReplaceModifiedContext

@Nullable
public Boolean getReplaceModifiedContext()

Returns:

the replaceModifiedContext value.

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.

getWriteBOM

@Nullable
public Boolean getWriteBOM()

Returns:

true if a Unicode BOM should be written to the start of the deployed file, false otherwise. null if not specified.

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.