com.puppycrawl.tools.checkstyle.checks.header
public abstract class AbstractHeaderCheck extends AbstractFileSetCheck
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.
|
protected com.google.common.collect.ImmutableList<String> |
getHeaderLines()
Return the header lines to check against.
|
protected void |
postprocessHeaderLines()
Hook method for post processing header lines.
|
void |
setCharset(String aCharset)
Set the charset to use for loading the header from a file.
|
void |
setHeader(String aHeader)
Set the header to check against.
|
void |
setHeaderFile(String aFileName)
Set the header file to check against.
|
beginProcessing, destroy, finishProcessing, fireErrors, 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
protected com.google.common.collect.ImmutableList<String> getHeaderLines()
public void setCharset(String aCharset) throws UnsupportedEncodingException
aCharset
- the charset to use for loading the header from a fileUnsupportedEncodingException
- if aCharset is unsupportedpublic void setHeaderFile(String aFileName)
aFileName
- the file that contains the header to check against.public void setHeader(String aHeader)
aHeader
- header content to check against.org.apache.commons.beanutils.ConversionException
- if the header cannot be interpretedprotected void postprocessHeaderLines()
protected final void finishLocalSetup() throws CheckstyleException
AutomaticBean
The default implementation does nothing.
finishLocalSetup
in class AutomaticBean
CheckstyleException
- if there is a configuration error.Copyright © 2001-2014. All Rights Reserved.