Package io.spring.javaformat.checkstyle

Class SpringChecks

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

io.spring.javaformat.checkstyle.SpringChecks

All Implemented Interfaces:

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

public class SpringChecks
extends com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
implements com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder

FileSetCheck that applies Spring checkstype rules.

Author:

Phillip Webb

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	Description
SpringChecks()

Method Summary

Modifier and Type	Method	Description
void	beginProcessing(String charset)
void	finishLocalSetup()
Set<String>	getExternalResourceLocations()
protected void	processFiltered(File file, com.puppycrawl.tools.checkstyle.api.FileText fileText)
void	setAvoidStaticImportExcludes(String[] avoidStaticImportExcludes)
void	setClassLoader(ClassLoader classLoader)	Sets classLoader to load class.
void	setExcludes(String... excludes)
void	setHeaderCopyrightPattern(String headerCopyrightPattern)
void	setHeaderFile(String headerFile)
void	setHeaderType(String headerType)
void	setModuleFactory(com.puppycrawl.tools.checkstyle.ModuleFactory moduleFactory)	Sets the module factory for creating child modules (Checks).
void	setProjectRootPackage(String projectRootPackage)
void	setupChild(com.puppycrawl.tools.checkstyle.api.Configuration configuration)

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

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

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

configure, contextualize, getConfiguration

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

SpringChecks

public SpringChecks()

Method Detail

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Sets classLoader to load class.

Parameters:

classLoader - class loader to resolve classes with.

setModuleFactory

public void setModuleFactory(com.puppycrawl.tools.checkstyle.ModuleFactory moduleFactory)

Sets the module factory for creating child modules (Checks).

Parameters:

moduleFactory - the factory

finishLocalSetup

public void finishLocalSetup()

Overrides:

finishLocalSetup in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getExternalResourceLocations

public Set<String> getExternalResourceLocations()

Specified by:

getExternalResourceLocations in interface com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder

beginProcessing

public void beginProcessing(String charset)

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(File file,
                               com.puppycrawl.tools.checkstyle.api.FileText fileText)
                        throws com.puppycrawl.tools.checkstyle.api.CheckstyleException

Specified by:

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

Throws:

com.puppycrawl.tools.checkstyle.api.CheckstyleException

setupChild

public void setupChild(com.puppycrawl.tools.checkstyle.api.Configuration configuration)
                throws com.puppycrawl.tools.checkstyle.api.CheckstyleException

Overrides:

setupChild in class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Throws:

com.puppycrawl.tools.checkstyle.api.CheckstyleException

setHeaderType

public void setHeaderType(String headerType)

setHeaderCopyrightPattern

public void setHeaderCopyrightPattern(String headerCopyrightPattern)

setHeaderFile

public void setHeaderFile(String headerFile)

setAvoidStaticImportExcludes

public void setAvoidStaticImportExcludes(String[] avoidStaticImportExcludes)

setProjectRootPackage

public void setProjectRootPackage(String projectRootPackage)

setExcludes

public void setExcludes(String... excludes)