org.digitalmediaserver.crowdin.api

Class FileExportOptions

java.lang.Object

org.digitalmediaserver.crowdin.api.FileExportOptions

public class FileExportOptions
extends Object

This class is used for serialization and deserialization of JSON objects when communicating with Crowdin's v2 API. It's a combination of several API classes, and thus represents GeneralFileExportOptions, PropertyFileExportOptions and JavaScriptFileExportOptions.

To make sure that only valid parameters are used for a given FileType, call validate(FileType).

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileExportOptions.JavaScriptExportQuotes Represents the Crowdin API exportQuotes JavaScript export options.

Constructor Summary

Constructors

Constructor and Description
FileExportOptions() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getEscapeQuotes()
Integer	getEscapeSpecialCharacters()
String	getExportPattern()
FileExportOptions.JavaScriptExportQuotes	getExportQuotes()
int	hashCode()
void	setEscapeQuotes(Integer escapeQuotes) Sets the escapeQuotes value.
void	setEscapeSpecialCharacters(Integer escapeSpecialCharacters) Sets the escapeSpecialCharacters value.
void	setExportPattern(String exportPattern) Sets the exportPattern value.
void	setExportQuotes(FileExportOptions.JavaScriptExportQuotes exportQuotes) Sets the exportQuotes value.
String	toString()
void	validate(FileType fileType) Validates that no option has been set that is invalid for the specified FileType.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileExportOptions

public FileExportOptions()

Creates a new instance.

Method Detail

validate

public void validate(@Nullable
            FileType fileType)
              throws org.apache.maven.plugin.MojoExecutionException

Validates that no option has been set that is invalid for the specified FileType.

Warning: If fileType is null or FileType.auto, no validation is performed.

Parameters:

fileType - the FileType for which to validate.

Throws:

org.apache.maven.plugin.MojoExecutionException - If validation fails.

getExportPattern

@Nullable
public String getExportPattern()

Returns:

The exportPattern value.

See Also:

exportPattern

setExportPattern

public void setExportPattern(@Nullable
                    String exportPattern)

Sets the exportPattern value.

Parameters:

exportPattern - the exportPattern value to set.

See Also:

exportPattern

getEscapeQuotes

public Integer getEscapeQuotes()

Returns:

The escapeQuotes value.

See Also:

escapeQuotes

setEscapeQuotes

public void setEscapeQuotes(Integer escapeQuotes)

Sets the escapeQuotes value.

Parameters:

escapeQuotes - the escapeQuotes value to set.

See Also:

escapeQuotes

getEscapeSpecialCharacters

public Integer getEscapeSpecialCharacters()

Returns:

The escapeSpecialCharacters value.

See Also:

escapeSpecialCharacters

setEscapeSpecialCharacters

public void setEscapeSpecialCharacters(Integer escapeSpecialCharacters)

Sets the escapeSpecialCharacters value.

Parameters:

escapeSpecialCharacters - the escapeSpecialCharacters value to set.

See Also:

escapeSpecialCharacters

getExportQuotes

public FileExportOptions.JavaScriptExportQuotes getExportQuotes()

Returns:

The exportQuotes value.

See Also:

exportQuotes

setExportQuotes

public void setExportQuotes(FileExportOptions.JavaScriptExportQuotes exportQuotes)

Sets the exportQuotes value.

Parameters:

exportQuotes - the FileExportOptions.JavaScriptExportQuotes value to set.

See Also:

exportQuotes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object