|
||||||||||
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.CrossLanguageRegexpHeaderCheck
public final class CrossLanguageRegexpHeaderCheck
A FileSetCheck similar to RegexpHeaderCheck
,
but works for all text files, not just java code.
Constructor Summary | |
---|---|
CrossLanguageRegexpHeaderCheck()
Creates a new instance and initializes the file extentions to the default value, which represents most of the typical text files that require a copyright header. |
Method Summary | |
---|---|
protected void |
finishLocalSetup()
Checks that required args were specified. |
void |
process(File[] aFiles)
Processes a set of files and fires errors to the MessageDispatcher. |
void |
setHeader(String aHeader)
Set the header to check against. |
void |
setHeaderFile(String aFileName)
Set the header file to check against. |
void |
setMultiLines(int[] aList)
Set the lines numbers to repeat in the header check. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck |
---|
destroy, filter, fireErrors, getCharset, getMessageCollector, getMessageDispatcher, log, log, setCharset, setFileExtensions, setMessageDispatcher |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
---|
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, 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 CrossLanguageRegexpHeaderCheck()
Method Detail |
---|
public void setMultiLines(int[] aList)
aList
- comma separated list of line numbers to repeat in header.public void setHeaderFile(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(String aHeader)
aHeader
- header content to check against.
org.apache.commons.beanutils.ConversionException
- if the header cannot be interpretedprotected void finishLocalSetup() throws CheckstyleException
finishLocalSetup
in class AutomaticBean
CheckstyleException
- if there is a configuration error.AutomaticBean.finishLocalSetup()
public void process(File[] aFiles)
aFiles
- the files to be audited.FileSetCheck.destroy()
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |