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.

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
void	checkIndentation()	Check the indentation of the expression we are handling.
protected int[]	getCheckedChildren()	Returns array of token types which should be checked among children.
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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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.

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.