|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.puppycrawl.tools.checkstyle.Configuration
Represents the configuration that checkstyle uses when checking. The configuration is Serializable, however the ClassLoader configuration is lost.
Constructor Summary | |
Configuration()
Creates a new Configuration instance. |
|
Configuration(java.util.Properties aProps,
java.io.PrintStream aLog)
Creates a new Configuration instance. |
Method Summary | |
java.lang.String |
getBasedir()
|
java.lang.String |
getCacheFile()
|
BlockOption |
getCatchBlock()
|
java.lang.ClassLoader |
getClassLoader()
|
BlockOption |
getFinallyBlock()
|
java.lang.String[] |
getHeaderLines()
|
boolean |
getHeaderLinesRegexp()
|
java.lang.String |
getIgnoreLineLengthPat()
|
org.apache.regexp.RE |
getIgnoreLineLengthRegexp()
|
java.util.Set |
getIllegalImports()
|
java.util.Set |
getIllegalInstantiations()
|
Scope |
getJavadocScope()
|
LeftCurlyOption |
getLCurlyMethod()
|
LeftCurlyOption |
getLCurlyOther()
|
LeftCurlyOption |
getLCurlyType()
|
java.lang.String |
getLocalVarPat()
|
org.apache.regexp.RE |
getLocalVarRegexp()
|
int |
getMaxConstructorLength()
|
int |
getMaxFileLength()
|
int |
getMaxLineLength()
|
int |
getMaxMethodLength()
|
java.lang.String |
getMemberPat()
|
org.apache.regexp.RE |
getMemberRegexp()
|
java.lang.String |
getMethodPat()
|
org.apache.regexp.RE |
getMethodRegexp()
|
java.lang.String |
getParamPat()
|
org.apache.regexp.RE |
getParamRegexp()
|
PadOption |
getParenPadOption()
|
java.lang.String |
getPublicMemberPat()
|
org.apache.regexp.RE |
getPublicMemberRegexp()
|
RightCurlyOption |
getRCurly()
|
java.lang.String |
getStaticFinalPat()
|
org.apache.regexp.RE |
getStaticFinalRegexp()
|
java.lang.String |
getStaticPat()
|
org.apache.regexp.RE |
getStaticRegexp()
|
int |
getTabWidth()
|
java.lang.String |
getTodoPat()
|
org.apache.regexp.RE |
getTodoRegexp()
|
BlockOption |
getTryBlock()
|
java.lang.String |
getTypePat()
|
org.apache.regexp.RE |
getTypeRegexp()
|
WrapOpOption |
getWrapOpOption()
|
boolean |
isAllowNoAuthor()
|
boolean |
isAllowPackage()
|
boolean |
isAllowProtected()
|
boolean |
isAllowTabs()
|
boolean |
isCheckUnusedThrows()
|
boolean |
isHeaderIgnoreLineNo(int aLineNo)
|
boolean |
isIgnoreBraces()
|
boolean |
isIgnoreCastWhitespace()
|
boolean |
isIgnoreImportLength()
|
boolean |
isIgnoreImports()
|
boolean |
isIgnoreLongEll()
|
boolean |
isIgnorePublicInInterface()
|
boolean |
isIgnoreWhitespace()
|
boolean |
isRequirePackageHtml()
|
void |
setBasedir(java.lang.String aTo)
|
void |
setBlockOptionProperty(java.lang.String aName,
BlockOption aTo)
Set an BlockOption property. |
void |
setBooleanProperty(java.lang.String aName,
boolean aTo)
Set the boolean property. |
void |
setCacheFile(java.lang.String aCacheFile)
|
void |
setClassLoader(java.lang.ClassLoader aLoader)
Set the class loader for locating classes. |
void |
setHeaderFile(java.lang.String aFileName)
|
void |
setHeaderIgnoreLines(java.lang.String aList)
|
void |
setIllegalImports(java.lang.String aPkgPrefixList)
|
void |
setIllegalInstantiations(java.lang.String aClassList)
|
void |
setIntProperty(java.lang.String aName,
int aTo)
Set an integer property. |
void |
setJavadocScope(Scope aJavadocScope)
|
void |
setLeftCurlyOptionProperty(java.lang.String aName,
LeftCurlyOption aTo)
Set an LeftCurlyOption property. |
void |
setParenPadOption(PadOption aTo)
|
void |
setPatternProperty(java.lang.String aName,
java.lang.String aPat)
Set an pattern property. |
void |
setRCurly(RightCurlyOption aTo)
|
void |
setWrapOpOption(WrapOpOption aTo)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Configuration(java.util.Properties aProps, java.io.PrintStream aLog) throws org.apache.regexp.RESyntaxException, java.io.FileNotFoundException, java.io.IOException
Configuration
instance.aProps
- where to extract configuration parameters fromaLog
- where to log errors toorg.apache.regexp.RESyntaxException
- if an error occursjava.io.FileNotFoundException
- if an error occursjava.io.IOException
- if an error occurspublic Configuration()
Configuration
instance.IllegalStateException
- if an error occursMethod Detail |
public java.lang.ClassLoader getClassLoader()
public java.lang.String getTodoPat()
public org.apache.regexp.RE getTodoRegexp()
public java.lang.String getParamPat()
public org.apache.regexp.RE getParamRegexp()
public java.lang.String getStaticPat()
public org.apache.regexp.RE getStaticRegexp()
public java.lang.String getStaticFinalPat()
public org.apache.regexp.RE getStaticFinalRegexp()
public java.lang.String getMemberPat()
public org.apache.regexp.RE getMemberRegexp()
public java.lang.String getPublicMemberPat()
public org.apache.regexp.RE getPublicMemberRegexp()
public java.lang.String getTypePat()
public org.apache.regexp.RE getTypeRegexp()
public java.lang.String getLocalVarPat()
public org.apache.regexp.RE getLocalVarRegexp()
public java.lang.String getMethodPat()
public org.apache.regexp.RE getMethodRegexp()
public int getMaxLineLength()
public int getMaxMethodLength()
public int getMaxConstructorLength()
public int getMaxFileLength()
public boolean isAllowTabs()
public int getTabWidth()
public boolean isAllowProtected()
public boolean isAllowPackage()
public boolean isAllowNoAuthor()
public Scope getJavadocScope()
public boolean isRequirePackageHtml()
public boolean isIgnoreImports()
public boolean isCheckUnusedThrows()
public java.util.Set getIllegalImports()
public java.util.Set getIllegalInstantiations()
public java.lang.String getIgnoreLineLengthPat()
public org.apache.regexp.RE getIgnoreLineLengthRegexp()
public boolean isIgnoreWhitespace()
public boolean isIgnoreCastWhitespace()
public boolean isIgnoreBraces()
public boolean isIgnoreLongEll()
public boolean isIgnorePublicInInterface()
public boolean isIgnoreImportLength()
public java.lang.String[] getHeaderLines()
public boolean getHeaderLinesRegexp()
public boolean isHeaderIgnoreLineNo(int aLineNo)
aLineNo
- a line numberaLineNo
is one of the ignored header lines.public java.lang.String getCacheFile()
public void setClassLoader(java.lang.ClassLoader aLoader)
aLoader
- the class loaderpublic void setIllegalImports(java.lang.String aPkgPrefixList)
aPkgPrefixList
- comma separated list of package prefixespublic void setIllegalInstantiations(java.lang.String aClassList)
aClassList
- comma separated list of fully qualified class namespublic void setJavadocScope(Scope aJavadocScope)
aJavadocScope
- visibility scope where Javadoc is checkedpublic void setBooleanProperty(java.lang.String aName, boolean aTo)
aName
- name of the property. Should be defined in Defn.aTo
- the value to setpublic void setHeaderFile(java.lang.String aFileName) throws java.io.FileNotFoundException, java.io.IOException
aFileName
- the header lines to check forjava.io.FileNotFoundException
- if an error occursjava.io.IOException
- if an error occurspublic void setHeaderIgnoreLines(java.lang.String aList)
aList
- comma separated list of line numbers to ignore in header.public void setCacheFile(java.lang.String aCacheFile)
aCacheFile
- name of cache filepublic LeftCurlyOption getLCurlyMethod()
public LeftCurlyOption getLCurlyType()
public LeftCurlyOption getLCurlyOther()
public RightCurlyOption getRCurly()
public void setRCurly(RightCurlyOption aTo)
aTo
- set the right curly placement optionpublic BlockOption getTryBlock()
public BlockOption getCatchBlock()
public BlockOption getFinallyBlock()
public PadOption getParenPadOption()
public void setParenPadOption(PadOption aTo)
aTo
- set the parenthesis optionpublic WrapOpOption getWrapOpOption()
public void setWrapOpOption(WrapOpOption aTo)
aTo
- set the wrap on operator optionpublic java.lang.String getBasedir()
public void setBasedir(java.lang.String aTo)
aTo
- sets the base directorypublic void setIntProperty(java.lang.String aName, int aTo)
aName
- name of the property to setaTo
- the value to setpublic void setPatternProperty(java.lang.String aName, java.lang.String aPat) throws org.apache.regexp.RESyntaxException
aName
- name of the property to setaPat
- the value to setorg.apache.regexp.RESyntaxException
- if an error occurspublic void setBlockOptionProperty(java.lang.String aName, BlockOption aTo)
aName
- name of the property to setaTo
- the value to setpublic void setLeftCurlyOptionProperty(java.lang.String aName, LeftCurlyOption aTo)
aName
- name of the property to setaTo
- the value to set
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |