com.puppycrawl.tools.checkstyle.checks.design

Class VisibilityModifierCheck

public class VisibilityModifierCheck extends Check

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.

Author: lkuehne

Constructor Summary
VisibilityModifierCheck()
Create an instance.
Method Summary
int[]getDefaultTokens()
{@inheritDoc}
booleanisPackageAllowed()
booleanisProtectedAllowed()
voidsetPackageAllowed(boolean aPackageAllowed)
Set whether package visible members are allowed.
voidsetProtectedAllowed(boolean aProtectedAllowed)
Set whether protected members are allowed.
voidsetPublicMemberPattern(String aPattern)
Set the pattern for public members to ignore.
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Constructor Detail

VisibilityModifierCheck

public VisibilityModifierCheck()
Create an instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

isPackageAllowed

public boolean isPackageAllowed()

Returns: whether package visible members are allowed

isProtectedAllowed

public boolean isProtectedAllowed()

Returns: whether protected members are allowed

setPackageAllowed

public void setPackageAllowed(boolean aPackageAllowed)
Set whether package visible members are allowed.

Parameters: aPackageAllowed whether package visible members are allowed

setProtectedAllowed

public void setProtectedAllowed(boolean aProtectedAllowed)
Set whether protected members are allowed.

Parameters: aProtectedAllowed whether protected members are allowed

setPublicMemberPattern

public void setPublicMemberPattern(String aPattern)
Set the pattern for public members to ignore.

Parameters: aPattern pattern for public members to ignore.

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc}