Package com.puppycrawl.tools.checkstyle.checks.indentation

Class ClassDefHandler

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler

com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler

com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler

public class ClassDefHandler
extends BlockParentHandler

Handler for class definitions.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	MODIFIER	Token for modifier.

Constructor Summary

Constructors

Constructor	Description
ClassDefHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent)	Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.

Method Summary

Modifier and Type	Method	Description
private void	checkAnnotationDefModifiers()	Checks modifiers for annotation definitions, skipping modifiers that are not at the start of the line.
private void	checkClassDefModifiers()	Checks modifiers for class definitions, skipping wrapped modifiers that appear on lines after the first modifier line.
void	checkIndentation()	Check the indentation of the expression we are handling.
private void	checkLineModifiers(DetailAST firstModifier, int firstModifierLine)	Checks modifiers on the first modifier line.
private void	checkModifiers()	Checks modifiers for class/annotation definitions.
private void	checkNonFirstLineModifiers(DetailAST firstNonAnnotationMod)	Checks modifiers on the line of the first non-annotation modifier, skipping correctly-indented annotations to avoid false positives when annotations wrap before the class keyword.
protected int[]	getCheckedChildren()	Returns array of token types which should be checked among children.
private static DetailAST	getFirstNonAnnotationModifier(DetailAST firstModifier)	Finds the first non-annotation modifier node.
private static String	getHandlerName(DetailAST ast)	Creates a handler name for this class according to ast type.
protected DetailAST	getLeftCurly()	Get the left curly brace portion of the expression we are handling.
protected DetailAST	getListChild()	Get the child element representing the list of statements.
protected DetailAST	getRightCurly()	Get the right curly brace portion of the expression we are handling.
protected DetailAST	getTopLevelAst()	Get the top level expression being managed by this handler.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler

canChildrenBeNested, checkTopLevelToken, curlyIndent, getChildrenExpectedIndent, getNonListChild, getSuggestedChildIndent, shouldCheckLeftParen, shouldCheckRightParen

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler

checkChildren, checkExpressionSubtree, checkLeftParen, checkRightParen, checkWrappingIndentation, checkWrappingIndentation, expandedTabsColumnNo, findSubtreeAst, getBasicOffset, getBraceAdjustment, getFirstAstNode, getFirstLine, getFirstToken, getIndent, getIndentCheck, getIndentImpl, getLineStart, getLineStart, getMainAst, getParent, isOnStartOfLine, logError, logError, shouldCheckIndentationForChild, shouldIncreaseIndent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODIFIER

private static final String MODIFIER

Token for modifier.

See Also:

• Constant Field Values

Constructor Details

ClassDefHandler

public ClassDefHandler(IndentationCheck indentCheck,
 DetailAST ast,
 AbstractExpressionHandler parent)

Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.

Parameters:

indentCheck - the indentation check

ast - the abstract syntax tree

parent - the parent handler

Method Details

getLeftCurly

protected DetailAST getLeftCurly()

Description copied from class: BlockParentHandler

Get the left curly brace portion of the expression we are handling.

Overrides:

getLeftCurly in class BlockParentHandler

Returns:

the left curly brace expression

getRightCurly

protected DetailAST getRightCurly()

Description copied from class: BlockParentHandler

Get the right curly brace portion of the expression we are handling.

Overrides:

getRightCurly in class BlockParentHandler

Returns:

the right curly brace expression

getTopLevelAst

protected DetailAST getTopLevelAst()

Description copied from class: BlockParentHandler

Get the top level expression being managed by this handler.

Overrides:

getTopLevelAst in class BlockParentHandler

Returns:

the top level expression

getListChild

protected DetailAST getListChild()

Description copied from class: BlockParentHandler

Get the child element representing the list of statements.

Overrides:

getListChild in class BlockParentHandler

Returns:

the statement list child

checkIndentation

public void checkIndentation()

Description copied from class: AbstractExpressionHandler

Check the indentation of the expression we are handling.

Overrides:

checkIndentation in class BlockParentHandler

getCheckedChildren

protected int[] getCheckedChildren()

Description copied from class: BlockParentHandler

Returns array of token types which should be checked among children.

Overrides:

getCheckedChildren in class BlockParentHandler

Returns:

array of token types to check.

checkModifiers

private void checkModifiers()

Checks modifiers for class/annotation definitions.

checkAnnotationDefModifiers

private void checkAnnotationDefModifiers()

Checks modifiers for annotation definitions, skipping modifiers that are not at the start of the line.

checkClassDefModifiers

private void checkClassDefModifiers()

Checks modifiers for class definitions, skipping wrapped modifiers that appear on lines after the first modifier line. Annotations that wrap before the class keyword are skipped only when they are correctly indented, since a correctly indented annotation before a wrongly indented class keyword is not itself a violation.

checkLineModifiers

private void checkLineModifiers(DetailAST firstModifier,
 int firstModifierLine)

Checks modifiers on the first modifier line.

Parameters:

firstModifier - the first modifier

firstModifierLine - line number of the first modifier

checkNonFirstLineModifiers

private void checkNonFirstLineModifiers(DetailAST firstNonAnnotationMod)

Checks modifiers on the line of the first non-annotation modifier, skipping correctly-indented annotations to avoid false positives when annotations wrap before the class keyword.

Parameters:

firstNonAnnotationMod - the first non-annotation modifier

getFirstNonAnnotationModifier

private static DetailAST getFirstNonAnnotationModifier(DetailAST firstModifier)

Finds the first non-annotation modifier node.

Parameters:

firstModifier - the first modifier in the modifiers list

Returns:

the first non-annotation modifier node

getHandlerName

private static String getHandlerName(DetailAST ast)

Creates a handler name for this class according to ast type.

Parameters:

ast - the abstract syntax tree.

Returns:

handler name for this class.