|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.puppycrawl.tools.checkstyle.api.AutomaticBean com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter com.puppycrawl.tools.checkstyle.api.Check com.puppycrawl.tools.checkstyle.checks.AbstractHeaderCheck
Abstract super class for header checks. Provides support for headerFile property.
Constructor Summary | |
AbstractHeaderCheck()
|
Method Summary | |
protected void |
finishLocalSetup()
Checks that required args were specified. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens. |
protected java.lang.String[] |
getHeaderLines()
Return the header lines to check against. |
void |
setHeader(java.lang.String aHeader)
Set the header to check against. |
void |
setHeaderFile(java.lang.String aFileName)
Set the header file to check against. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, 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 |
Constructor Detail |
public AbstractHeaderCheck()
Method Detail |
protected java.lang.String[] getHeaderLines()
public void setHeaderFile(java.lang.String aFileName) throws org.apache.commons.beanutils.ConversionException
aFileName
- the file that contains the header to check against.
org.apache.commons.beanutils.ConversionException
- if the file cannot be loadedpublic void setHeader(java.lang.String aHeader)
aHeader
- header content to check against.
org.apache.commons.beanutils.ConversionException
- if the header cannot be interpretedprotected final void finishLocalSetup() throws CheckstyleException
finishLocalSetup
in class AutomaticBean
CheckstyleException
- if there is a configuration error.AutomaticBean.finishLocalSetup()
public final int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |