com.puppycrawl.tools.checkstyle.checks.javadoc

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.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowLegacy Indicates if allow legacy "package.html" file to be used.
private java.util.Set<java.io.File>	directoriesChecked The directories checked.
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 and Description
JavadocPackageCheck() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	beginProcessing(java.lang.String charset) Called when about to be called to process a set of files.
protected void	processFiltered(java.io.File file, java.util.List<java.lang.String> lines) 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

destroy, finishProcessing, fireErrors, getFileExtensions, getMessageCollector, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, 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

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

beginProcessing

public void beginProcessing(java.lang.String charset)

Description copied from interface: FileSetCheck

Called when about to be called to process a set of files.

Specified by:

beginProcessing in interface FileSetCheck

Overrides:

beginProcessing in class AbstractFileSetCheck

Parameters:

charset - the character set used to read the files.

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.