Class JavadocPackageCheck
- 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.javadoc.JavadocPackageCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,FileSetCheck
public class JavadocPackageCheck extends AbstractFileSetCheck
Checks that all packages have a package documentation. See the documentation for more information.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MSG_LEGACY_PACKAGE_HTML
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_PACKAGE_INFO
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description JavadocPackageCheck()
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
processFiltered(java.io.File file, FileText fileText)
Called to process a file that matches the specified file extensions.void
setAllowLegacy(boolean allowLegacy)
Indicates whether to allow support for the legacy package.html file.-
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 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
-
-
Method Detail
-
processFiltered
protected void processFiltered(java.io.File file, FileText fileText) throws CheckstyleException
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.- Throws:
CheckstyleException
- if error condition within Checkstyle occurs.
-
setAllowLegacy
public void setAllowLegacy(boolean allowLegacy)
Indicates whether to allow support for the legacy package.html file.- Parameters:
allowLegacy
- whether to allow support.
-
-