|
||||||||||
| 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.Check
com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
public class VisibilityModifierCheck
Checks visibility of class members. Only static final members may be public, other class members must be private unless allowProtected/Package is set.
Public members are not flagged if the name matches the public member regular expression (contains "^serialVersionUID$" by default).
Rationale: Enforce encapsulation.
| Constructor Summary | |
|---|---|
VisibilityModifierCheck()
Create an instance. |
|
| Method Summary | |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
boolean |
isPackageAllowed()
|
boolean |
isProtectedAllowed()
|
void |
setPackageAllowed(boolean aPackageAllowed)
Set whether package visible members are allowed. |
void |
setProtectedAllowed(boolean aProtectedAllowed)
Set whether protected members are allowed. |
void |
setPublicMemberPattern(String aPattern)
Set the pattern for public members to ignore. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
| 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 |
| 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, finishLocalSetup, getConfiguration, setupChild |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public VisibilityModifierCheck()
| Method Detail |
|---|
public boolean isProtectedAllowed()
public void setProtectedAllowed(boolean aProtectedAllowed)
aProtectedAllowed - whether protected members are allowedpublic boolean isPackageAllowed()
public void setPackageAllowed(boolean aPackageAllowed)
aPackageAllowed - whether package visible members are allowedpublic void setPublicMemberPattern(String aPattern)
aPattern - pattern for public members to ignore.public int[] getDefaultTokens()
Check
getDefaultTokens in class CheckTokenTypespublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to process
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||