|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
public abstract class AbstractHeaderCheck
Abstract super class for header checks. Provides support for header and headerFile properties.
| Constructor Summary | |
|---|---|
AbstractHeaderCheck()
|
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck |
|---|
beginProcessing, destroy, finishProcessing, fireErrors, 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 |
|---|
public AbstractHeaderCheck()
| Method Detail |
|---|
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 file
UnsupportedEncodingException - 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
AutomaticBeanThe default implementation does nothing.
finishLocalSetup in class AutomaticBeanCheckstyleException - if there is a configuration error.
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||