Class AbstractHeaderCheck
- 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.header.AbstractHeaderCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,ExternalResourceHolder
,FileSetCheck
- Direct Known Subclasses:
HeaderCheck
,RegexpHeaderCheck
public abstract class AbstractHeaderCheck extends AbstractFileSetCheck implements ExternalResourceHolder
Abstract super class for header checks. Provides support for header and headerFile properties.- Author:
- o_sukhosolsky
-
-
Constructor Summary
Constructors Constructor Description AbstractHeaderCheck()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
finishLocalSetup()
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.Set<String>
getExternalResourceLocations()
Returns a set of external configuration resource locations which are used by the module.protected List<String>
getHeaderLines()
Return the header lines to check against.protected abstract void
postProcessHeaderLines()
Hook method for post processing header lines.void
setCharset(String charset)
Set the charset to use for loading the header from a file.void
setHeader(String header)
Set the header to check against.void
setHeaderFile(URI uri)
Set the header file to check against.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
beginProcessing, destroy, finishProcessing, fireErrors, getFileExtensions, getMessageCollector, getMessageDispatcher, init, log, log, process, processFiltered, 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, 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
-
AbstractHeaderCheck
public AbstractHeaderCheck()
-
-
Method Detail
-
postProcessHeaderLines
protected abstract void postProcessHeaderLines()
Hook method for post processing header lines. This implementation does nothing.
-
getHeaderLines
protected List<String> getHeaderLines()
Return the header lines to check against.- Returns:
- the header lines to check against.
-
setCharset
public void setCharset(String charset) throws UnsupportedEncodingException
Set the charset to use for loading the header from a file.- Parameters:
charset
- the charset to use for loading the header from a file- Throws:
UnsupportedEncodingException
- if charset is unsupported
-
setHeaderFile
public void setHeaderFile(URI uri) throws CheckstyleException
Set the header file to check against.- Parameters:
uri
- the uri of the header to load.- Throws:
CheckstyleException
- if fileName is empty.
-
setHeader
public void setHeader(String header)
Set the header to check against. Individual lines in the header must be separated by '\n' characters.- Parameters:
header
- header content to check against.- Throws:
IllegalArgumentException
- if the header cannot be interpreted
-
finishLocalSetup
protected final void finishLocalSetup() throws CheckstyleException
Description copied from class:AutomaticBean
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.The default implementation does nothing.
- Overrides:
finishLocalSetup
in classAutomaticBean
- Throws:
CheckstyleException
- if there is a configuration error.
-
getExternalResourceLocations
public Set<String> getExternalResourceLocations()
Description copied from interface:ExternalResourceHolder
Returns a set of external configuration resource locations which are used by the module. ATTENTION! If 'getExternalResourceLocations()' return null, there will beNullPointerException
inChecker
. Such behaviour will signal that your module (check or filter) is designed incorrectly. It make sense to return an empty set from 'getExternalResourceLocations()' only for composite modules likeTreeWalker
.- Specified by:
getExternalResourceLocations
in interfaceExternalResourceHolder
- Returns:
- a set of external configuration resource locations which are used by the module.
-
-