ModuleDirectoryLayoutCheck (Checkstyle Addons)

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:

Configurable, Contextualizable, FileSetCheck
```
public class ModuleDirectoryLayoutCheck
extends 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
  AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors
Constructor Description

ModuleDirectoryLayoutCheck()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`beginProcessing(String pCharset)`
`protected void`	`processFiltered(File pFile, FileText pLines)`
`protected void`	`processFiltered(File pFile, List<String> pLines)`
`void`	`setBaseDir(String pBaseDir)`
`void`	`setConfigFile(String pConfigFile)`	Setter.
`void`	`setFailQuietly(boolean pFailQuietly)`

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addViolations, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, 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(String pCharset)
```
Specified by:

beginProcessing in interface FileSetCheck

Overrides:

beginProcessing in class AbstractFileSetCheck

processFiltered

protected void processFiltered(File pFile,
                               List<String> pLines)

processFiltered

protected void processFiltered(File pFile,
                               FileText pLines)

Specified by:: processFiltered in class AbstractFileSetCheck

setBaseDir

public void setBaseDir(String pBaseDir)

setConfigFile

public final void setConfigFile(@Nonnull
                                String pConfigFile)

Setter.

Parameters:: pConfigFile - the location of the JSON configuration file

setFailQuietly

public void setFailQuietly(boolean pFailQuietly)