net.sf.yal10n.settings.CheckConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yal10n-maven-plugin Show documentation
Yet Another L10N Maven Plugin
The newest version!
package net.sf.yal10n.settings;

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Configures various aspects of messages.properties file checks.
 */
public class CheckConfiguration
{
    private double percentageMissing = 10.0d;
    private List includeVariants = Arrays.asList( "zh_CN", "zh_TW" );
    private boolean checkFileHeaders = false;
    private String fileHeaderRegexp = "";
    private List ignoreKeys = new ArrayList();
    private int issuesThreshold = 5;

    /**
     * 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%.
     * @return the percentage of missing/not-translated messages that are not a problem.
     */
    public double getPercentageMissing()
    {
        return 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%.
     * @param percentageMissing the new value
     */
    public void setPercentageMissing( double percentageMissing )
    {
        this.percentageMissing = percentageMissing;
    }

    /**
     * Whether the file header check is enabled.
     * @return true if the file header check is enabled.
     * @see #getFileHeaderRegexp()
     */
    public boolean isCheckFileHeaders()
    {
        return checkFileHeaders;
    }

    /**
     * Sets whether the file header check is enabled.
     * @param checkFileHeaders true if the file header check is enabled.
     * @see #getFileHeaderRegexp()
     */
    public void setCheckFileHeaders( boolean checkFileHeaders )
    {
        this.checkFileHeaders = checkFileHeaders;
    }

    /**
     * Gets the regular expression used to check the file headers.
     * @return the regular expression
     * @see #isCheckFileHeaders()
     */
    public String getFileHeaderRegexp()
    {
        return fileHeaderRegexp;
    }

    /**
     * Sets the regular expression used to check the file headers.
     * @param fileHeaderRegexp the regular expression
     * @see #isCheckFileHeaders()
     */
    public void setFileHeaderRegexp( String fileHeaderRegexp )
    {
        this.fileHeaderRegexp = fileHeaderRegexp;
    }

    /**
     * Gets the list of messages keys, that should be ignored in any statistic.
     * @return the list of keys that should be ignored.
     */
    public List getIgnoreKeys()
    {
        return ignoreKeys;
    }

    /**
     * Sets the list of messages keys, that should be ignored in any statistic.
     * @param ignoreKeys the list of keys that should be ignored.
     */
    public void setIgnoreKeys( List ignoreKeys )
    {
        this.ignoreKeys = ignoreKeys;
    }

    /**
     * Determines how many issues should be considered to be a major problem.
     * Default value is 5.
     * @return number of issues that make the problem major.
     */
    public int getIssuesThreshold()
    {
        return issuesThreshold;
    }

    /**
     * Sets the number of issues that are needed to considering the issues as a major problem.
     * @param issueThreshold number of issues
     */
    public void setIssueThreshold( int issueThreshold )
    {
        this.issuesThreshold = issueThreshold;
    }

    /**
     * Gets the list of language variants, that should not be excluded in the checks.
     * Default are: zh_CN and zh_TW.
     * @return the list of language variants
     */
    public List getIncludeVariants()
    {
        return includeVariants;
    }

    /**
     * Sets the list of language variants, that should not be excluded in the checks.
     * @param includeVariants the list of language variants
     */
    public void setIncludeVariants( List includeVariants )
    {
        this.includeVariants = includeVariants;
    }
}