net.sf.okapi.filters.markdown

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.markdown.Parameters

All Implemented Interfaces:

IParameters

public class Parameters
extends StringParameters

Field Summary

Fields inherited from class net.sf.okapi.common.StringParameters

buffer

Fields inherited from class net.sf.okapi.common.BaseParameters

path

Constructor Summary

Constructors

Constructor and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
void	fromString(String data) Reset this parameters object to its default values and then load additional parameters from the provided data.
String	getCharactersToEscape()
InlineCodeFinder	getCodeFinder()
String	getHtmlEntitiesToEscape()
String	getHtmlSubfilter() The configuration that the HTML subfilter uses, if set.
String	getNonTranslateBlocks()
boolean	getTranslateFencedCodeBlocks()
boolean	getTranslateHeaderMetadata()
boolean	getTranslateImageAltText()
boolean	getTranslateIndentedCodeBlocks()
boolean	getTranslateInlineCodeBlocks()
boolean	getTranslateUrls()
boolean	getUnescapeBackslashCharacters()
String	getUrlToTranslatePattern()
boolean	getUseCodeFinder()
String	getYamlSubfilter()
void	reset() Reset this parameters object to its default values.
void	setCharactersToEscape(String charactersToEscape)
void	setHtmlEntitiesToEscape(String htmlEntitiesToEscape)
void	setHtmlSubfilter(String htmlSubfilter) Uses the user-supplied HTML sub-filter configuration rather than Markdown's default.
void	setNonTranslateBlocks(String nonTranslatableBlocks)
void	setTranslateFencedCodeBlocks(boolean translateCodeBlocks)
void	setTranslateHeaderMetadata(boolean translateHeaderMetadata)
void	setTranslateImageAltText(boolean translateImageAltText)
void	setTranslateIndentedCodeBlocks(boolean translateIndentedCodeBlocks)
void	setTranslateInlineCodeBlocks(boolean translateInlineCodeBlocks)
void	setTranslateUrls(boolean translateUrls)
void	setUnescapeBackslashCharacters(boolean unescapeBackslashCharacters)
void	setUrlToTranslatePattern(String urlToTranslatePattern)
void	setUseCodeFinder(boolean useCodeFinder)
void	setYamlSubfilter(String yamlSubfilter)
String	toString() Serialize this parameters object to a string.

Methods inherited from class net.sf.okapi.common.StringParameters

fromString, getBoolean, getGroup, getInteger, getString, setBoolean, setGroup, setInteger, setString

Methods inherited from class net.sf.okapi.common.BaseParameters

getParametersDescription, getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Method Detail

getHtmlSubfilter

public String getHtmlSubfilter()

The configuration that the HTML subfilter uses, if set.

Returns:

The configuration file path, or null if Markdown filter's default HTML configuration is used.

setHtmlSubfilter

public void setHtmlSubfilter(String htmlSubfilter)

Uses the user-supplied HTML sub-filter configuration rather than Markdown's default.

Parameters:

htmlSubfilter - The path of the configuration yml file which typically has the .fprm suffix.

getUseCodeFinder

public boolean getUseCodeFinder()

setUseCodeFinder

public void setUseCodeFinder(boolean useCodeFinder)

getTranslateUrls

public boolean getTranslateUrls()

setTranslateUrls

public void setTranslateUrls(boolean translateUrls)

getUrlToTranslatePattern

public String getUrlToTranslatePattern()

setUrlToTranslatePattern

public void setUrlToTranslatePattern(String urlToTranslatePattern)

getTranslateFencedCodeBlocks

public boolean getTranslateFencedCodeBlocks()

setTranslateFencedCodeBlocks

public void setTranslateFencedCodeBlocks(boolean translateCodeBlocks)

getTranslateIndentedCodeBlocks

public boolean getTranslateIndentedCodeBlocks()

setTranslateIndentedCodeBlocks

public void setTranslateIndentedCodeBlocks(boolean translateIndentedCodeBlocks)

getTranslateInlineCodeBlocks

public boolean getTranslateInlineCodeBlocks()

setTranslateInlineCodeBlocks

public void setTranslateInlineCodeBlocks(boolean translateInlineCodeBlocks)

getTranslateHeaderMetadata

public boolean getTranslateHeaderMetadata()

setTranslateHeaderMetadata

public void setTranslateHeaderMetadata(boolean translateHeaderMetadata)

getTranslateImageAltText

public boolean getTranslateImageAltText()

setTranslateImageAltText

public void setTranslateImageAltText(boolean translateImageAltText)

getHtmlEntitiesToEscape

public String getHtmlEntitiesToEscape()

setHtmlEntitiesToEscape

public void setHtmlEntitiesToEscape(String htmlEntitiesToEscape)

getUnescapeBackslashCharacters

public boolean getUnescapeBackslashCharacters()

setUnescapeBackslashCharacters

public void setUnescapeBackslashCharacters(boolean unescapeBackslashCharacters)

getCharactersToEscape

public String getCharactersToEscape()

setCharactersToEscape

public void setCharactersToEscape(String charactersToEscape)

getCodeFinder

public InlineCodeFinder getCodeFinder()

getNonTranslateBlocks

public String getNonTranslateBlocks()

setNonTranslateBlocks

public void setNonTranslateBlocks(String nonTranslatableBlocks)

getYamlSubfilter

public String getYamlSubfilter()

setYamlSubfilter

public void setYamlSubfilter(String yamlSubfilter)

reset

public void reset()

Description copied from class: StringParameters

Reset this parameters object to its default values.

Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

Specified by:

reset in interface IParameters

Overrides:

reset in class StringParameters

fromString

public void fromString(String data)

Description copied from class: StringParameters

Reset this parameters object to its default values and then load additional parameters from the provided data.

Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

Specified by:

fromString in interface IParameters

Overrides:

fromString in class StringParameters

Parameters:

data - the string holding the parameters. It must be formatted as the string generated by toString(). Line-breaks must be normalized to '\n'. It can also be null or empty, in such case the parameters are left with their current values. Use reset() to reset the parameters to their defaults.

toString

public String toString()

Description copied from class: StringParameters

Serialize this parameters object to a string.

Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra serialization as part of their parameter state.

Specified by:

toString in interface IParameters

Overrides:

toString in class StringParameters

Returns:

the string holding all the parameters.