com.puppycrawl.tools.checkstyle.checks.indentation

Class LineWrappingHandler

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler

public class LineWrappingHandler
extends java.lang.Object

This class checks line-wrapping into definitions and expressions. The line-wrapping indentation should be not less than value of the lineWrappingIndentation parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineWrappingHandler.LineWrappingOptions Enum to be used for test if first line's indentation should be checked or not.

Constructor Summary

Constructors

Constructor and Description
LineWrappingHandler(IndentationCheck instance) Sets values of class field, finds last node and calculates indentation level.

Method Summary

Modifier and Type	Method and Description
void	checkForAnnotationIndentation(java.util.NavigableMap<java.lang.Integer,DetailAST> firstNodesOnLines, int indentLevel) Checks for annotation indentation.
static boolean	checkForMethodLparenNewLine(DetailAST node) Checks whether the method lparen starts from a new line or not.
static boolean	checkForNullParameterChild(DetailAST node) Checks whether parameter node has any child or not.
void	checkIndentation(DetailAST firstNode, DetailAST lastNode) Checks line wrapping into expressions and definitions using property 'lineWrappingIndentation'.
void	checkIndentation(DetailAST firstNode, DetailAST lastNode, int indentLevel, int startIndent, LineWrappingHandler.LineWrappingOptions ignoreFirstLine) Checks line wrapping into expressions and definitions.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineWrappingHandler

public LineWrappingHandler(IndentationCheck instance)

Sets values of class field, finds last node and calculates indentation level.

Parameters:

instance - instance of IndentationCheck.

Method Detail

checkIndentation

public void checkIndentation(DetailAST firstNode,
                             DetailAST lastNode)

Checks line wrapping into expressions and definitions using property 'lineWrappingIndentation'.

Parameters:

firstNode - First node to start examining.

lastNode - Last node to examine inclusively.

checkIndentation

public void checkIndentation(DetailAST firstNode,
                             DetailAST lastNode,
                             int indentLevel,
                             int startIndent,
                             LineWrappingHandler.LineWrappingOptions ignoreFirstLine)

Checks line wrapping into expressions and definitions.

Parameters:

firstNode - First node to start examining.

lastNode - Last node to examine inclusively.

indentLevel - Indentation all wrapped lines should use.

startIndent - Indentation first line before wrapped lines used.

ignoreFirstLine - Test if first line's indentation should be checked or not.

checkForAnnotationIndentation

public void checkForAnnotationIndentation(java.util.NavigableMap<java.lang.Integer,DetailAST> firstNodesOnLines,
                                          int indentLevel)

Checks for annotation indentation.

Parameters:

firstNodesOnLines - the nodes which are present in the beginning of each line.

indentLevel - line wrapping indentation.

checkForNullParameterChild

public static boolean checkForNullParameterChild(DetailAST node)

Checks whether parameter node has any child or not.

Parameters:

node - the node for which to check.

Returns:

true if parameter has no child.

checkForMethodLparenNewLine

public static boolean checkForMethodLparenNewLine(DetailAST node)

Checks whether the method lparen starts from a new line or not.

Parameters:

node - the node for which to check.

Returns:

true if method lparen starts from a new line.