net.sf.yal10n.settings

Class CheckConfiguration

java.lang.Object

net.sf.yal10n.settings.CheckConfiguration

public class CheckConfiguration
extends Object

Configures various aspects of messages.properties file checks.

Constructor Summary

Constructors

Constructor and Description
CheckConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFileHeaderRegexp() Gets the regular expression used to check the file headers.
List<String>	getIgnoreKeys() Gets the list of messages keys, that should be ignored in any statistic.
List<String>	getIncludeVariants() Gets the list of language variants, that should not be excluded in the checks.
int	getIssuesThreshold() Determines how many issues should be considered to be a major problem.
double	getPercentageMissing() Determines how many messages are allowed to be missing (missing or not translated) before a minor issue should be raised.
boolean	isCheckFileHeaders() Whether the file header check is enabled.
void	setCheckFileHeaders(boolean checkFileHeaders) Sets whether the file header check is enabled.
void	setFileHeaderRegexp(String fileHeaderRegexp) Sets the regular expression used to check the file headers.
void	setIgnoreKeys(List<String> ignoreKeys) Sets the list of messages keys, that should be ignored in any statistic.
void	setIncludeVariants(List<String> includeVariants) Sets the list of language variants, that should not be excluded in the checks.
void	setIssueThreshold(int issueThreshold) Sets the number of issues that are needed to considering the issues as a major problem.
void	setPercentageMissing(double percentageMissing) Sets how many messages are allowed to be missing (missing or not translated) before a minor issue should be raised.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckConfiguration

public CheckConfiguration()

Method Detail

getPercentageMissing

public double getPercentageMissing()

Determines how many messages are allowed to be missing (missing or not translated) before a minor issue should be raised. The value is in percentage. Default value is 10%.

Returns:

the percentage of missing/not-translated messages that are not a problem.

setPercentageMissing

public void setPercentageMissing(double percentageMissing)

Sets how many messages are allowed to be missing (missing or not translated) before a minor issue should be raised. The value is in percentage. Default value is 10%.

Parameters:

percentageMissing - the new value

isCheckFileHeaders

public boolean isCheckFileHeaders()

Whether the file header check is enabled.

Returns:

true if the file header check is enabled.

See Also:

getFileHeaderRegexp()

setCheckFileHeaders

public void setCheckFileHeaders(boolean checkFileHeaders)

Sets whether the file header check is enabled.

Parameters:

checkFileHeaders - true if the file header check is enabled.

See Also:

getFileHeaderRegexp()

getFileHeaderRegexp

public String getFileHeaderRegexp()

Gets the regular expression used to check the file headers.

Returns:

the regular expression

See Also:

isCheckFileHeaders()

setFileHeaderRegexp

public void setFileHeaderRegexp(String fileHeaderRegexp)

Sets the regular expression used to check the file headers.

Parameters:

fileHeaderRegexp - the regular expression

See Also:

isCheckFileHeaders()

getIgnoreKeys

public List<String> getIgnoreKeys()

Gets the list of messages keys, that should be ignored in any statistic.

Returns:

the list of keys that should be ignored.

setIgnoreKeys

public void setIgnoreKeys(List<String> ignoreKeys)

Sets the list of messages keys, that should be ignored in any statistic.

Parameters:

ignoreKeys - the list of keys that should be ignored.

getIssuesThreshold

public int getIssuesThreshold()

Determines how many issues should be considered to be a major problem. Default value is 5.

Returns:

number of issues that make the problem major.

setIssueThreshold

public void setIssueThreshold(int issueThreshold)

Sets the number of issues that are needed to considering the issues as a major problem.

Parameters:

issueThreshold - number of issues

getIncludeVariants

public List<String> getIncludeVariants()

Gets the list of language variants, that should not be excluded in the checks. Default are: zh_CN and zh_TW.

Returns:

the list of language variants

setIncludeVariants

public void setIncludeVariants(List<String> includeVariants)

Sets the list of language variants, that should not be excluded in the checks.

Parameters:

includeVariants - the list of language variants