org.digitalmediaserver.crowdin.configuration

Class AbstractFileSet

java.lang.Object

org.digitalmediaserver.crowdin.configuration.AbstractFileSet

Direct Known Subclasses:

StatusFile, TranslationFileSet

public abstract class AbstractFileSet
extends Object

An abstract Mojo configuration class describing a set of files.

Author:

Nadahar

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	addComment Whether or not to add a comment header to the files when exporting them from Crowdin.
protected Charset	charset For internal use.
protected String	comment The custom comment header to add to translation files when exporting them from Crowdin if addComment is true.
protected List<Conversion>	conversions A list of Conversion elements to apply to the translation file names.
protected String	encoding The encoding to use when deploying the translation files.
protected Boolean	escapeUnicode Whether or not to encode Unicode characters in the form "\uxxxx" when exporting files from Crowdin.
protected String	lineSeparator The string to use as line separator when exporting files from Crowdin.
protected Boolean	sortLines Whether or not the language strings should be sorted by their key in the translation files when exporting them from Crowdin.
protected FileType	type The FileType for this fileset.

Constructor Summary

Constructors

Constructor and Description
AbstractFileSet()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAddComment()
Charset	getCharset()
String	getComment()
List<Conversion>	getConversions()
String	getEncoding()
Boolean	getEscapeUnicode()
String	getLineSeparator()
Boolean	getSortLines()
FileType	getType()
static void	initialize(List<? extends AbstractFileSet> fileSets) Since the constructor is called automagically by Maven, verification and initialization of defaults is done here.
protected void	initializeInstance() Since the constructor is called automagically by Maven, verification and initialization of defaults is done here.
void	setCharset(Charset charset)
void	setEncoding(String encoding)
void	setType(FileType type)

Methods inherited from class java.lang.Object

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

Field Detail

encoding

@Nullable
protected String encoding

The encoding to use when deploying the translation files. This can either be a valid Charset name, or the special value "Properties". Encoding is often determined by type and only need to be explicitly set to deviate from the default.

The "Properties" maps to StandardCharsets.ISO_8859_1. Together with escapeUnicode == true, any characters that don't exist in ISO 8859-1 will be encoded as \u<xxxx> where <xxxx> is the hexadecimal Unicode value.

Is defined by:

sortLines

@Nullable
protected Boolean sortLines

Whether or not the language strings should be sorted by their key in the translation files when exporting them from Crowdin. Mostly useful for Properties files. Defaults to true if encoding is "Properties", false otherwise.

Is defined by:

addComment

@Nullable
protected Boolean addComment

Whether or not to add a comment header to the files when exporting them from Crowdin. If no custom comment is provided, a generic "do not modify" comment will be added.

Is defined by:

default-value:

true

comment

@Nullable
protected String comment

The custom comment header to add to translation files when exporting them from Crowdin if addComment is true. If not configured, a generic "do not modify" comment will be added.

Is defined by:

lineSeparator

@Nullable
protected String lineSeparator

The string to use as line separator when exporting files from Crowdin. Specify \n, \r or \r\n as needed. If not specified, the default will be used.

Is defined by:

escapeUnicode

@Nullable
protected Boolean escapeUnicode

Whether or not to encode Unicode characters in the form "\uxxxx" when exporting files from Crowdin. This setting only applies to FileType.properties file sets.

Is defined by:

default-value:

true

type

@Nullable
protected FileType type

The FileType for this fileset. If not specified, auto-detection will be attempted with fall-back to FileType.auto.

Is defined by:

conversions

@Nullable
protected List<Conversion> conversions

A list of Conversion elements to apply to the translation file names.

Is defined by:

charset

@Nullable
protected Charset charset

For internal use.

Constructor Detail

AbstractFileSet

public AbstractFileSet()

Method Detail

getEncoding

@Nullable
public String getEncoding()

Returns:

The character encoding to convert translation files to when exporting them from Crowdin or null if not set.

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the character encoding to convert translation files to when exporting them from Crowdin or null to use the default.

getCharset

@Nullable
public Charset getCharset()

Returns:

The Charset to convert translation files to when exporting them from Crowdin or null to use the default.

setCharset

public void setCharset(@Nullable
              Charset charset)

Parameters:

charset - the Charset to convert translation files to when exporting them from Crowdin or null to use the default.

getSortLines

@Nullable
public Boolean getSortLines()

Returns:

true if lines should be sorted when exporting files from Crowdin, false otherwise.

getAddComment

@Nullable
public Boolean getAddComment()

Returns:

true if a comment should be added at the top of the translated files when exporting them from Crowdin, false if it should not or null if not specified.

getComment

@Nullable
public String getComment()

Returns:

The custom comment header to add to translation files when exporting them from Crowdin, or null if the default should be used.

getLineSeparator

@Nullable
public String getLineSeparator()

Returns:

The String to use as line separator when exporting files from Crowdin or null to use the default.

getEscapeUnicode

@Nullable
public Boolean getEscapeUnicode()

Returns:

Whether to escape Unicode characters with "\uxxxx" in FileType.properties files when exporting them from Crowdin, or null if not set.

getType

@Nullable
public FileType getType()

Returns:

The FileType.

setType

public void setType(@Nullable
           FileType type)

Parameters:

type - the FileType to set.

getConversions

@Nullable
public List<Conversion> getConversions()

Returns:

The List of Conversions.

initialize

public static void initialize(@Nullable
              List<? extends AbstractFileSet> fileSets)
                       throws org.apache.maven.plugin.MojoExecutionException

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

Parameters:

fileSets - the List of file sets to initialize.

Throws:

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

initializeInstance

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

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

Throws:

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