Class UniquePropertiesCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable, FileSetCheck

    public class UniquePropertiesCheck
    extends AbstractFileSetCheck

    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 is java.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
    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        Localization key for check violation.
        See Also:
        Constant Field Values
      • MSG_IO_EXCEPTION_KEY

        public static final java.lang.String MSG_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​(java.io.File file,
                                       FileText fileText)
        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
        fileText - the contents of the file.