Package | Description |
---|---|
com.puppycrawl.tools.checkstyle.api |
Contains the core API to be used to implement checks.
|
com.puppycrawl.tools.checkstyle.checks.coding |
Contains the Coding checks that are
bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.checks.sizes |
Contains the Size Violations checks
that are bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.utils |
Contains utils classes for checkstyle.
|
Modifier and Type | Method and Description |
---|---|
static Scope |
Scope.getInstance(java.lang.String scopeName)
Scope factory method.
|
static Scope |
Scope.valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static Scope[] |
Scope.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
boolean |
Scope.isIn(Scope scope)
Checks if this scope is a subscope of another scope.
|
Modifier and Type | Field and Description |
---|---|
private Scope |
DeclarationOrderCheck.ScopeState.declarationAccess
The sub-state the check is in.
|
Modifier and Type | Field and Description |
---|---|
private Scope |
JavadocTypeCheck.excludeScope
The visibility scope where Javadoc comments shouldn't be checked.
|
private Scope |
JavadocVariableCheck.excludeScope
The visibility scope where Javadoc comments shouldn't be checked.
|
private Scope |
JavadocMethodCheck.excludeScope
The visibility scope where Javadoc comments shouldn't be checked.
|
private Scope |
JavadocStyleCheck.excludeScope
The visibility scope where Javadoc comments shouldn't be checked.
|
private Scope |
JavadocTypeCheck.scope
The scope to check for.
|
private Scope |
JavadocVariableCheck.scope
The scope to check.
|
private Scope |
JavadocMethodCheck.scope
The visibility scope where Javadoc comments are checked.
|
private Scope |
JavadocStyleCheck.scope
The scope to check.
|
Modifier and Type | Method and Description |
---|---|
private static Scope |
JavadocMethodCheck.calculateScope(DetailAST ast)
Returns the scope for the method/constructor at the specified AST.
|
Modifier and Type | Method and Description |
---|---|
void |
JavadocTypeCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocVariableCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocMethodCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocStyleCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocTypeCheck.setScope(Scope scope)
Sets the scope to check.
|
void |
JavadocVariableCheck.setScope(Scope scope)
Sets the scope to check.
|
void |
JavadocMethodCheck.setScope(Scope scope)
Set the scope.
|
void |
JavadocStyleCheck.setScope(Scope scope)
Sets the scope to check.
|
private boolean |
JavadocMethodCheck.shouldCheck(DetailAST ast,
Scope nodeScope)
Whether we should check this node.
|
Modifier and Type | Field and Description |
---|---|
private java.util.Map<Scope,java.lang.Integer> |
MethodCountCheck.MethodCounter.counts
Maintains the counts.
|
Modifier and Type | Method and Description |
---|---|
private void |
MethodCountCheck.MethodCounter.increment(Scope scope)
Increments to counter by one for the supplied scope.
|
private int |
MethodCountCheck.MethodCounter.value(Scope scope)
Gets the value of a scope counter.
|
Modifier and Type | Method and Description |
---|---|
static Scope |
ScopeUtils.getScopeFromMods(DetailAST aMods)
Returns the Scope specified by the modifier set.
|
static Scope |
ScopeUtils.getSurroundingScope(DetailAST node)
Returns the scope of the surrounding "block".
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ScopeUtils.isInScope(DetailAST ast,
Scope scope)
Checks whether ast node is in a specific scope.
|