Package net.sf.okapi.steps.patternschecker

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.steps.patternschecker.Parameters

All Implemented Interfaces:

Cloneable, 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	Description
Parameters()

Method Summary

Modifier and Type	Method	Description
void	fromString(String data)	Reset this parameters object to its default values and then load additional parameters from the provided data.
boolean	getCheckPatterns()
List<PatternItem>	getPatterns()
void	reset()	Reset this parameters object to its default values.
void	setCheckPatterns(boolean patterns)
void	setPatterns(List<PatternItem> patterns)
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

Methods inherited from interface net.sf.okapi.common.IParameters

copy

Constructor Detail

Parameters

public Parameters()

Method Detail

getCheckPatterns

public boolean getCheckPatterns()

setCheckPatterns

public void setCheckPatterns(boolean patterns)

getPatterns

public List<PatternItem> getPatterns()

setPatterns

public void setPatterns(List<PatternItem> patterns)

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.