com.thomasjensen.checkstyle.addons.checks.misc

Class ModuleDirectoryLayoutCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

com.thomasjensen.checkstyle.addons.checks.misc.ModuleDirectoryLayoutCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable, com.puppycrawl.tools.checkstyle.api.FileSetCheck

public class ModuleDirectoryLayoutCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

This check helps ensure that the source folder structure in a module follows a configurable convention.

Documentation

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
ModuleDirectoryLayoutCheck() Constructor.

Method Summary

Modifier and Type	Method and Description
void	beginProcessing(java.lang.String pCharset)
protected void	processFiltered(java.io.File pFile, com.puppycrawl.tools.checkstyle.api.FileText pLines)
protected void	processFiltered(java.io.File pFile, java.util.List<java.lang.String> pLines)
void	setBaseDir(java.lang.String pBaseDir)
void	setConfigFile(java.lang.String pConfigFile) Setter.
void	setFailQuietly(boolean pFailQuietly)

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

addMessages, 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

Constructor Detail

ModuleDirectoryLayoutCheck

public ModuleDirectoryLayoutCheck()

Constructor. Activates the default config file, which may be overridden by the configFile check property.

Method Detail

beginProcessing

public void beginProcessing(java.lang.String pCharset)

Specified by:

beginProcessing in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck

Overrides:

beginProcessing in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

processFiltered

protected void processFiltered(java.io.File pFile,
                               com.puppycrawl.tools.checkstyle.api.FileText pLines)

Specified by:

processFiltered in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

processFiltered

protected void processFiltered(java.io.File pFile,
                               java.util.List<java.lang.String> pLines)

setBaseDir

public void setBaseDir(java.lang.String pBaseDir)

setConfigFile

public final void setConfigFile(@Nonnull
                                java.lang.String pConfigFile)

Setter.

Parameters:

pConfigFile - the location of the JSON configuration file

setFailQuietly

public void setFailQuietly(boolean pFailQuietly)