net.sf.okapi.steps.rainbowkit.xliff

Class Options

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.steps.rainbowkit.xliff.Options

All Implemented Interfaces:

IParameters, IEditorDescriptionProvider

public class Options
extends StringParameters
implements IEditorDescriptionProvider

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
Options()

Method Summary

Modifier and Type	Method and Description
EditorDescription	createEditorDescription(ParametersDescription paramsDesc)
void	fromString(String data) Reset this parameters object to its default values and then load additional parameters from the provided data.
boolean	getCopySource()
boolean	getEscapeGT()
boolean	getIncludeAltTrans()
boolean	getIncludeCodeAttrs()
boolean	getIncludeIts()
boolean	getIncludeNoTranslate()
ParametersDescription	getParametersDescription() Gets the description of the parameters.
boolean	getPlaceholderMode()
boolean	getSetApprovedAsNoTranslate()
void	reset() Reset this parameters object to its default values.
void	setCopySource(boolean copySource)
void	setEscapeGT(boolean escapeGT)
void	setIncludeAltTrans(boolean includeAltTrans)
void	setIncludeCodeAttrs(boolean includeCodeAttrs)
void	setIncludeIts(boolean includeIts)
void	setIncludeNoTranslate(boolean includeNoTranslate)
void	setPlaceholderMode(boolean placeholderMode)
void	setSetApprovedAsNoTranslate(boolean setApprovedAsNoTranslate)

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

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

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

getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

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.

getPlaceholderMode

public boolean getPlaceholderMode()

setPlaceholderMode

public void setPlaceholderMode(boolean placeholderMode)

getIncludeNoTranslate

public boolean getIncludeNoTranslate()

setIncludeNoTranslate

public void setIncludeNoTranslate(boolean includeNoTranslate)

getSetApprovedAsNoTranslate

public boolean getSetApprovedAsNoTranslate()

setSetApprovedAsNoTranslate

public void setSetApprovedAsNoTranslate(boolean setApprovedAsNoTranslate)

getCopySource

public boolean getCopySource()

setCopySource

public void setCopySource(boolean copySource)

getIncludeAltTrans

public boolean getIncludeAltTrans()

setIncludeAltTrans

public void setIncludeAltTrans(boolean includeAltTrans)

getIncludeCodeAttrs

public boolean getIncludeCodeAttrs()

setIncludeCodeAttrs

public void setIncludeCodeAttrs(boolean includeCodeAttrs)

getIncludeIts

public boolean getIncludeIts()

setIncludeIts

public void setIncludeIts(boolean includeIts)

getEscapeGT

public boolean getEscapeGT()

setEscapeGT

public void setEscapeGT(boolean escapeGT)

getParametersDescription

public ParametersDescription getParametersDescription()

Description copied from interface: IParameters

Gets the description of the parameters.

Specified by:

getParametersDescription in interface IParameters

Overrides:

getParametersDescription in class BaseParameters

Returns:

the ParametersDescription object for this set of parameters, or null if none is provided.

createEditorDescription

public EditorDescription createEditorDescription(ParametersDescription paramsDesc)

Specified by:

createEditorDescription in interface IEditorDescriptionProvider