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
Detects duplicated keys in properties files.
Rationale: Multiple property keys usually appear after merge or rebase of several branches. While there are no problems in runtime, there can be a confusion due to having different values for the duplicated properties.
-
Property
fileExtensions
- Specify file type extension of the files to check. Type isjava.lang.String[]
. Default value is.properties
.
To configure the check:
<module name="UniqueProperties"> <property name="fileExtensions" value="properties" /> </module>
Parent is com.puppycrawl.tools.checkstyle.Checker
Violation Message Keys:
-
properties.duplicate.property
-
unable.open.cause
- Since:
- 5.7
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
processFiltered
(File file, FileText fileText) Called to process a file that matches the specified file extensions.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getMessages, getTabWidth, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, 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 Details
-
MSG_KEY
Localization key for check violation.- See Also:
-
MSG_IO_EXCEPTION_KEY
Localization key for IO exception occurred on file open.- See Also:
-
-
Constructor Details
-
UniquePropertiesCheck
public UniquePropertiesCheck()Construct the check with default values.
-
-
Method Details
-
processFiltered
Description copied from class:AbstractFileSetCheck
Called to process a file that matches the specified file extensions.- Specified by:
processFiltered
in classAbstractFileSetCheck
- Parameters:
file
- the file to be processedfileText
- the contents of the file.
-