com.puppycrawl.tools.checkstyle.checks

Class UniquePropertiesCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck

public class UniquePropertiesCheck
extends AbstractFileSetCheck

Checks the uniqueness of property keys (left from equal sign) in the properties file.

Author:

Pavel Baranchikov

Field Summary

Fields

Modifier and Type	Field and Description
static String	IO_EXCEPTION_KEY Localization key for IO exception occurred on file open.
static String	MSG_KEY Localization key for check violation.

Constructor Summary

Constructors

Constructor and Description
UniquePropertiesCheck() Construct the check with default values.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	getLineNumber(List<String> lines, String keyName) Method returns line number the key is detected in the checked properties files first.
protected void	processFiltered(File file, List<String> lines) Called to process a file that matches the specified file extensions.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

beginProcessing, destroy, finishProcessing, fireErrors, getMessageCollector, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable

configure

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable

contextualize

Field Detail

MSG_KEY

public static final String MSG_KEY

Localization key for check violation.

See Also:

Constant Field Values

IO_EXCEPTION_KEY

public static final String IO_EXCEPTION_KEY

Localization key for IO exception occurred on file open.

See Also:

Constant Field Values

Constructor Detail

UniquePropertiesCheck

public UniquePropertiesCheck()

Construct the check with default values.

Method Detail

processFiltered

protected void processFiltered(File file,
                   List<String> lines)

Description copied from class: AbstractFileSetCheck

Called to process a file that matches the specified file extensions.

Specified by:

processFiltered in class AbstractFileSetCheck

Parameters:

file - the file to be processed

lines - an immutable list of the contents of the file.

getLineNumber

protected int getLineNumber(List<String> lines,
                String keyName)

Method returns line number the key is detected in the checked properties files first.

Parameters:

lines - properties file lines list

keyName - key name to look for

Returns:

line number of first occurrence. If no key found in properties file, 0 is returned