org.digitalmediaserver.crowdin.api

Class FileImportOptions

java.lang.Object

org.digitalmediaserver.crowdin.api.FileImportOptions

public class FileImportOptions
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 SpreadsheetFileImportOptions, XlsxFileImportOptions, HtmlFileImportOptions, FmHtmlFileImportOptions, MdxV1FileImportOptions, MdxV2FileImportOptions, XmlFileImportOptions, DocxFileImportOptions, SegmentationImportOptions, CustomSegmentationImportOptions, StringCatalogImportOptions, AdocFileImportOptions and OtherFilesImportOptions.

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

Author:

Nadahar

Constructor Summary

Constructors

Constructor and Description
FileImportOptions() Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getCleanTagsAggressively()
Boolean	getContentSegmentation()
Boolean	getCustomSegmentation()
Boolean	getExcludeCodeBlocks()
String[]	getExcludedElements()
String[]	getExcludedFrontMatterElements()
Boolean	getExcludeIncludeDirectives()
Boolean	getFirstLineContainsHeader()
Boolean	getImportHiddenSheets()
Boolean	getImportHiddenSlides()
Boolean	getImportKeyAsSource()
Boolean	getImportNotes()
Boolean	getImportTranslations()
Long	getSrxStorageId()
String[]	getTranslatableElements()
Boolean	getTranslateAttributes()
Boolean	getTranslateContent()
Boolean	getTranslateHiddenRowsAndColumns()
Boolean	getTranslateHiddenText()
Boolean	getTranslateHyperlinkUrls()
int	hashCode()
void	setCleanTagsAggressively(Boolean cleanTagsAggressively) Sets whether to clean tags aggressively.
void	setContentSegmentation(Boolean contentSegmentation) Sets whether content segmentation is enabled.
void	setCustomSegmentation(Boolean customSegmentation) Sets whether custom segmentation is enabled.
void	setExcludeCodeBlocks(Boolean excludeCodeBlocks) Sets whether to exclude code blocks.
void	setExcludedElements(String[] excludedElements) Sets an array CSS selectors for elements that should not be imported.
void	setExcludedFrontMatterElements(String[] excludedFrontMatterElements) Sets an array of elements that should not be imported.
void	setExcludeIncludeDirectives(Boolean excludeIncludeDirectives) Sets whether to skip include directives.
void	setFirstLineContainsHeader(Boolean firstLineContainsHeader) Sets whether the first line contains a header.
void	setImportHiddenSheets(Boolean importHiddenSheets) Sets whether to import hidden sheets.
void	setImportHiddenSlides(Boolean importHiddenSlides) Sets whether to import hidden slides.
void	setImportKeyAsSource(Boolean importKeyAsSource) Sets whether to import keys as source strings.
void	setImportNotes(Boolean importNotes) Sets whether to import notes.
void	setImportTranslations(Boolean importTranslations) Sets whether to import translations.
void	setSrxStorageId(Long srxStorageId) Sets the SRX segmentation rules storage id.
void	setTranslatableElements(String[] translatableElements) Sets the array of translatable elements.
void	setTranslateAttributes(Boolean translateAttributes) Sets whether to translate tags attributes.
void	setTranslateContent(Boolean translateContent) Sets whether to translate content inside tags.
void	setTranslateHiddenRowsAndColumns(Boolean translateHiddenRowsAndColumns) Sets whether to translate hidden rows and columns.
void	setTranslateHiddenText(Boolean translateHiddenText) Sets whether to translate hidden text.
void	setTranslateHyperlinkUrls(Boolean translateHyperlinkUrls) Sets whether to translate hyperlinks.
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

FileImportOptions

public FileImportOptions()

Create 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.

getContentSegmentation

@Nullable
public Boolean getContentSegmentation()

Returns:

The contentSegmentation value.

setContentSegmentation

public void setContentSegmentation(Boolean contentSegmentation)

Sets whether content segmentation is enabled.

Parameters:

contentSegmentation - the contentSegmentation value to set.

getCustomSegmentation

@Nullable
public Boolean getCustomSegmentation()

Returns:

The customSegmentation.

setCustomSegmentation

public void setCustomSegmentation(Boolean customSegmentation)

Sets whether custom segmentation is enabled.

Parameters:

customSegmentation - the customSegmentation value to set.

getSrxStorageId

@Nullable
public Long getSrxStorageId()

Returns:

The srxStorageId value.

setSrxStorageId

public void setSrxStorageId(Long srxStorageId)

Sets the SRX segmentation rules storage id.

Parameters:

srxStorageId - the srxStorageId value to set.

getFirstLineContainsHeader

@Nullable
public Boolean getFirstLineContainsHeader()

Returns:

The firstLineContainsHeader value.

setFirstLineContainsHeader

public void setFirstLineContainsHeader(Boolean firstLineContainsHeader)

Sets whether the first line contains a header.

Parameters:

firstLineContainsHeader - the firstLineContainsHeader value to set.

getImportHiddenSheets

@Nullable
public Boolean getImportHiddenSheets()

Returns:

The importHiddenSheets value.

setImportHiddenSheets

public void setImportHiddenSheets(Boolean importHiddenSheets)

Sets whether to import hidden sheets.

Parameters:

importHiddenSheets - the importHiddenSheets value to set.

getImportTranslations

@Nullable
public Boolean getImportTranslations()

Returns:

The importTranslations value.

setImportTranslations

public void setImportTranslations(Boolean importTranslations)

Sets whether to import translations.

Parameters:

importTranslations - the importTranslations value to set.

getTranslateContent

@Nullable
public Boolean getTranslateContent()

Returns:

The translateContent value.

setTranslateContent

public void setTranslateContent(Boolean translateContent)

Sets whether to translate content inside tags.

Parameters:

translateContent - the translateContent value to set.

getTranslateAttributes

@Nullable
public Boolean getTranslateAttributes()

Returns:

The translateAttributes value.

setTranslateAttributes

public void setTranslateAttributes(Boolean translateAttributes)

Sets whether to translate tags attributes.

Parameters:

translateAttributes - the translateAttributes value to set.

getTranslatableElements

@Nullable
public String[] getTranslatableElements()

Returns:

The translatableElements value.

setTranslatableElements

public void setTranslatableElements(String[] translatableElements)

Sets the array of translatable elements.

Parameters:

translatableElements - the translatableElements value to set.

getCleanTagsAggressively

@Nullable
public Boolean getCleanTagsAggressively()

Returns:

The cleanTagsAggressively value.

setCleanTagsAggressively

public void setCleanTagsAggressively(Boolean cleanTagsAggressively)

Sets whether to clean tags aggressively.

Parameters:

cleanTagsAggressively - the cleanTagsAggressively value to set.

getTranslateHiddenText

@Nullable
public Boolean getTranslateHiddenText()

Returns:

The translateHiddenText value.

setTranslateHiddenText

public void setTranslateHiddenText(Boolean translateHiddenText)

Sets whether to translate hidden text.

Parameters:

translateHiddenText - the translateHiddenText value to set.

getTranslateHyperlinkUrls

@Nullable
public Boolean getTranslateHyperlinkUrls()

Returns:

The translateHyperlinkUrls value.

setTranslateHyperlinkUrls

public void setTranslateHyperlinkUrls(Boolean translateHyperlinkUrls)

Sets whether to translate hyperlinks.

Parameters:

translateHyperlinkUrls - the translateHyperlinkUrls value to set.

getTranslateHiddenRowsAndColumns

@Nullable
public Boolean getTranslateHiddenRowsAndColumns()

Returns:

The translateHiddenRowsAndColumns value.

setTranslateHiddenRowsAndColumns

public void setTranslateHiddenRowsAndColumns(Boolean translateHiddenRowsAndColumns)

Sets whether to translate hidden rows and columns.

Parameters:

translateHiddenRowsAndColumns - the translateHiddenRowsAndColumns value to set.

getImportNotes

@Nullable
public Boolean getImportNotes()

Returns:

The importNotes value.

setImportNotes

public void setImportNotes(Boolean importNotes)

Sets whether to import notes.

Parameters:

importNotes - the importNotes value to set.

getImportHiddenSlides

@Nullable
public Boolean getImportHiddenSlides()

Returns:

The importHiddenSlides value.

setImportHiddenSlides

public void setImportHiddenSlides(Boolean importHiddenSlides)

Sets whether to import hidden slides.

Parameters:

importHiddenSlides - the importHiddenSlides value to set.

getExcludedElements

@Nullable
public String[] getExcludedElements()

Returns:

The excludedElements value.

setExcludedElements

public void setExcludedElements(String[] excludedElements)

Sets an array CSS selectors for elements that should not be imported.

Parameters:

excludedElements - the excludedElements value to set.

getExcludedFrontMatterElements

@Nullable
public String[] getExcludedFrontMatterElements()

Returns:

The excludedFrontMatterElements value.

setExcludedFrontMatterElements

public void setExcludedFrontMatterElements(String[] excludedFrontMatterElements)

Sets an array of elements that should not be imported.

Parameters:

excludedFrontMatterElements - the excludedFrontMatterElements value to set.

getExcludeCodeBlocks

@Nullable
public Boolean getExcludeCodeBlocks()

Returns:

The excludeCodeBlocks value.

setExcludeCodeBlocks

public void setExcludeCodeBlocks(Boolean excludeCodeBlocks)

Sets whether to exclude code blocks.

Parameters:

excludeCodeBlocks - the excludeCodeBlocks value to set.

getImportKeyAsSource

@Nullable
public Boolean getImportKeyAsSource()

Returns:

The importKeyAsSource value.

setImportKeyAsSource

public void setImportKeyAsSource(Boolean importKeyAsSource)

Sets whether to import keys as source strings.

Parameters:

importKeyAsSource - the importKeyAsSource value to set.

getExcludeIncludeDirectives

@Nullable
public Boolean getExcludeIncludeDirectives()

Returns:

The excludeIncludeDirectives value.

setExcludeIncludeDirectives

public void setExcludeIncludeDirectives(Boolean excludeIncludeDirectives)

Sets whether to skip include directives.

Parameters:

excludeIncludeDirectives - the excludeIncludeDirectives value to set.

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