Class JavadocPackageCheck

    • Field Detail

      • MSG_LEGACY_PACKAGE_HTML

        public static final java.lang.String MSG_LEGACY_PACKAGE_HTML
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • MSG_PACKAGE_INFO

        public static final java.lang.String MSG_PACKAGE_INFO
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • directoriesChecked

        private final java.util.Set<java.io.File> directoriesChecked
        The directories checked.
      • allowLegacy

        private boolean allowLegacy
        Indicates if allow legacy "package.html" file to be used.
    • Constructor Detail

      • JavadocPackageCheck

        public JavadocPackageCheck()
        Creates a new instance.
    • Method Detail

      • processFiltered

        protected void processFiltered​(java.io.File file,
                                       java.util.List<java.lang.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.
      • setAllowLegacy

        public void setAllowLegacy​(boolean allowLegacy)
        Indicates whether to allow support for the legacy package.html file.
        Parameters:
        allowLegacy - whether to allow support.