Class JavadocPackageCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- 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 each Java package has a Javadoc file used for commenting. By default, it only allows apackage-info.java
file, but can be configured to allow apackage.html
file.A violation will be reported if both files exist as this is not allowed by the Javadoc tool.
-
Property
allowLegacy
- Allow legacypackage.html
file to be used. Type isboolean
. Default value isfalse
. -
Property
fileExtensions
- Specify the file extensions of the files to process. Type isjava.lang.String[]
. Default value is.java
.
Parent is
com.puppycrawl.tools.checkstyle.Checker
Violation Message Keys:
-
javadoc.legacyPackageHtml
-
javadoc.packageInfo
- Since:
- 5.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowLegacy
Allow legacypackage.html
file to be used.private Set<File>
directoriesChecked
The directories checked.static String
MSG_LEGACY_PACKAGE_HTML
A key is pointing to the warning message text in "messages.properties" file.static 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(File file, FileText fileText)
Called to process a file that matches the specified file extensions.void
setAllowLegacy(boolean allowLegacy)
Setter to allow legacypackage.html
file to be used.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addViolations, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getTabWidth, getViolations, 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.AbstractAutomaticBean
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 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 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 Set<File> directoriesChecked
The directories checked.
-
allowLegacy
private boolean allowLegacy
Allow legacypackage.html
file to be used.
-
-
Constructor Detail
-
JavadocPackageCheck
public JavadocPackageCheck()
Creates a new instance.
-
-
Method Detail
-
processFiltered
protected void processFiltered(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)
Setter to allow legacypackage.html
file to be used.- Parameters:
allowLegacy
- whether to allow support.- Since:
- 5.0
-
-