com.puppycrawl.tools.checkstyle.api

Class ScopeUtils

public final class ScopeUtils extends Object

Contains utility methods for working on scope.

Version: 1.0

Author: Oliver Burn

Method Summary
static ScopegetScopeFromMods(DetailAST aMods)
Returns the Scope specified by the modifier set.
static ScopegetSurroundingScope(DetailAST aAST)
Returns the scope of the surrounding "block".
static booleaninAnnotationBlock(DetailAST aAST)
Returns whether a node is directly contained within an annotation block.
static booleaninCodeBlock(DetailAST aAST)
Returns whether the scope of a node is restricted to a code block.
static booleaninEnumBlock(DetailAST aAST)
Returns whether a node is directly contained within an enum block.
static booleaninInterfaceBlock(DetailAST aAST)
Returns whether a node is directly contained within an interface block.
static booleaninInterfaceOrAnnotationBlock(DetailAST aAST)
Returns whether a node is directly contained within an interface or annotation block.
static booleanisLocalVariableDef(DetailAST aAST)
Determines whether a node is a local variable definition.
static booleanisOuterMostType(DetailAST aAST)
Returns whether a node is contained in the outer most type block.

Method Detail

getScopeFromMods

public static Scope getScopeFromMods(DetailAST aMods)
Returns the Scope specified by the modifier set.

Parameters: aMods root node of a modifier set

Returns: a Scope value

getSurroundingScope

public static Scope getSurroundingScope(DetailAST aAST)
Returns the scope of the surrounding "block".

Parameters: aAST the node to return the scope for

Returns: the Scope of the surrounding block

inAnnotationBlock

public static boolean inAnnotationBlock(DetailAST aAST)
Returns whether a node is directly contained within an annotation block.

Parameters: aAST the node to check if directly contained within an annotation block

Returns: a boolean value

inCodeBlock

public static boolean inCodeBlock(DetailAST aAST)
Returns whether the scope of a node is restricted to a code block. A code block is a method or constructor body, or a initialiser block.

Parameters: aAST the node to check

Returns: a boolean value

inEnumBlock

public static boolean inEnumBlock(DetailAST aAST)
Returns whether a node is directly contained within an enum block.

Parameters: aAST the node to check if directly contained within an enum block

Returns: a boolean value

inInterfaceBlock

public static boolean inInterfaceBlock(DetailAST aAST)
Returns whether a node is directly contained within an interface block.

Parameters: aAST the node to check if directly contained within an interface block

Returns: a boolean value

inInterfaceOrAnnotationBlock

public static boolean inInterfaceOrAnnotationBlock(DetailAST aAST)
Returns whether a node is directly contained within an interface or annotation block.

Parameters: aAST the node to check if directly contained within an interface or annotation block

Returns: a boolean value

isLocalVariableDef

public static boolean isLocalVariableDef(DetailAST aAST)
Determines whether a node is a local variable definition. I.e. if it is declared in a code block, a for initializer, or a catch parameter.

Parameters: aAST the node to check.

Returns: whether aAST is a local variable definition.

isOuterMostType

public static boolean isOuterMostType(DetailAST aAST)
Returns whether a node is contained in the outer most type block.

Parameters: aAST the node to check

Returns: a boolean value