com.puppycrawl.tools.checkstyle.checks.header
Class AbstractHeaderCheck
- Configurable, Contextualizable
public abstract class AbstractHeaderCheck
Abstract super class for header checks.
Provides support for headerFile property.
protected abstract com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo | createHeaderInfo() - Abstract factory method to create an unconfigured
header info bean.
|
protected void | finishLocalSetup() - Checks that required args were specified.
|
int[] | getDefaultTokens() -
|
protected com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo | getHeaderInfo() - Return the header info to check against.
|
protected String[] | getHeaderLines() - Return the header lines to check against.
|
void | setHeader(String aHeader) - Set the header to check against.
|
void | setHeaderFile(String aFileName) - Set the header file to check against.
|
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getId , getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setId , setSeverity |
createHeaderInfo
protected abstract com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo createHeaderInfo()
Abstract factory method to create an unconfigured
header info bean. Note that the actual type of the
return value can be subclass specific.
- a header info bean for this check.
getHeaderInfo
protected com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo getHeaderInfo()
Return the header info to check against.
- the header info to check against.
getHeaderLines
protected String[] getHeaderLines()
Return the header lines to check against.
- the header lines to check against.
setHeader
public void setHeader(String aHeader)
Set the header to check against. Individual lines in the header
must be separated by '\n' characters.
aHeader
- header content to check against.
setHeaderFile
public void setHeaderFile(String aFileName)
throws ConversionException
Set the header file to check against.
aFileName
- the file that contains the header to check against.