public abstract class AbstractHeaderCheck extends AbstractFileSetCheck implements ExternalResourceHolder
Constructor and Description |
---|
AbstractHeaderCheck() |
Modifier and Type | Method and 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 com.google.common.collect.ImmutableList<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(String fileName)
Set the header file to check against.
|
beginProcessing, destroy, finishProcessing, fireErrors, getFileExtensions, getMessageCollector, getMessageDispatcher, init, log, log, process, processFiltered, setFileExtensions, setMessageDispatcher
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, getConfiguration, setupChild
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
configure
contextualize
public AbstractHeaderCheck()
protected abstract void postProcessHeaderLines()
protected com.google.common.collect.ImmutableList<String> getHeaderLines()
public void setCharset(String charset) throws UnsupportedEncodingException
charset
- the charset to use for loading the header from a fileUnsupportedEncodingException
- if charset is unsupportedpublic void setHeaderFile(String fileName) throws CheckstyleException
fileName
- the file that contains the header to check against.CheckstyleException
- if fileName is empty.public void setHeader(String header)
header
- header content to check against.org.apache.commons.beanutils.ConversionException
- if the header cannot be interpretedprotected final void finishLocalSetup() throws CheckstyleException
AutomaticBean
The default implementation does nothing.
finishLocalSetup
in class AutomaticBean
CheckstyleException
- if there is a configuration error.public Set<String> getExternalResourceLocations()
ExternalResourceHolder
NullPointerException
in Checker
.
Such behaviour will signal that your module (check or filter) is designed incorrectrly.
It make sence to return an empty set from 'getExternalResourceLocations()'
only for composite modules like TreeWalker
.getExternalResourceLocations
in interface ExternalResourceHolder
Copyright © 2001–2017. All rights reserved.