com.puppycrawl.tools.checkstyle.checks.design
Class VisibilityModifierCheck
- Configurable, Contextualizable
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.
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 |
VisibilityModifierCheck
public VisibilityModifierCheck()
Create an instance.
isPackageAllowed
public boolean isPackageAllowed()
- whether package visible members are allowed
isProtectedAllowed
public boolean isProtectedAllowed()
- whether protected members are allowed
setPackageAllowed
public void setPackageAllowed(boolean aPackageAllowed)
Set whether package visible members are allowed.
aPackageAllowed - whether package visible members are allowed
setProtectedAllowed
public void setProtectedAllowed(boolean aProtectedAllowed)
Set whether protected members are allowed.
aProtectedAllowed - whether protected members are allowed
setPublicMemberPattern
public void setPublicMemberPattern(String aPattern)
Set the pattern for public members to ignore.
aPattern - pattern for public members to ignore.