IndentationCheck (checkstyle 8.26 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractCheck
    - - com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck

All Implemented Interfaces:

Configurable, Contextualizable
```
public class IndentationCheck
extends AbstractCheck
```
Checks correct indentation of Java code.

The idea behind this is that while pretty printers are sometimes convenient for bulk reformats of legacy code, they often either aren't configurable enough or just can't anticipate how format should be done. Sometimes this is personal preference, other times it is practical experience. In any case, this check should just ensure that a minimal set of indentation rules is followed.
- Property basicOffset - Specify how far new indentation level should be indented when on the next line. Default value is 4.
- Property braceAdjustment - Specify how far a braces should be indented when on the next line. Default value is 0.
- Property caseIndent - Specify how far a case label should be indented when on next line. Default value is 4.
- Property throwsIndent - Specify how far a throws clause should be indented when on next line. Default value is 4.
- Property arrayInitIndent - Specify how far an array initialisation should be indented when on next line. Default value is 4.
- Property lineWrappingIndentation - Specify how far continuation line should be indented when line-wrapping is present. Default value is 4.
- Property forceStrictCondition - Force strict indent level in line wrapping case. If value is true, line wrap indent have to be same as lineWrappingIndentation parameter. If value is false, line wrap indent could be bigger on any value user would like. Default value is false.
To configure the check:
```
 <module name="Indentation"/>
 
```
To configure the check to enforce the indentation style recommended by Oracle:
```
 <module name="Indentation">
   <property name="caseIndent" value="0"/>
 </module>
 
```
To configure the Check to enforce strict condition in line-wrapping validation.
```
 <module name="Indentation">
   <property name="forceStrictCondition" value="true"/>
 </module>
 
```
Such config doesn't allow next cases:
```
 void foo(String aFooString,
         int aFooInt) {} // indent:8 ; expected: 4; warn, because 8 != 4
 
```
But if forceStrictCondition = false, this code is valid:
```
 void foo(String aFooString,
         int aFooInt) {} // indent:8 ; expected: > 4; ok, because 8 > 4
 
```
Since:

3.1

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  AutomaticBean.OutputStreamOptions

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MSG_CHILD_ERROR` A key is pointing to the warning message text in "messages.properties" file.
`static java.lang.String`	`MSG_CHILD_ERROR_MULTI` A key is pointing to the warning message text in "messages.properties" file.
`static java.lang.String`	`MSG_ERROR` A key is pointing to the warning message text in "messages.properties" file.
`static java.lang.String`	`MSG_ERROR_MULTI` A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors
Constructor and Description

IndentationCheck()

Constructors
Constructor and Description
`IndentationCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginTree(DetailAST ast)` Called before the starting to process a tree.
`int[]`	`getAcceptableTokens()` The configurable token set.
`int`	`getArrayInitIndent()` Getter to query how far an array initialisation should be indented when on next line.
`int`	`getBasicOffset()` Getter to query how far new indentation level should be indented when on the next line.
`int`	`getBraceAdjustment()` Getter to query how far a braces should be indented when on the next line.
`int`	`getCaseIndent()` Getter to query how far a case label should be indented when on next line.
`int[]`	`getDefaultTokens()` Returns the default token a check is interested in.
`HandlerFactory`	`getHandlerFactory()` Accessor for the handler factory.
`int`	`getIndentationTabWidth()` Get the width of a tab.
`LineWrappingHandler`	`getLineWrappingHandler()` Accessor for the line wrapping handler.
`int`	`getLineWrappingIndentation()` Getter to query how far continuation line should be indented when line-wrapping is present.
`int[]`	`getRequiredTokens()` The tokens that this check must be registered for.
`int`	`getThrowsIndent()` Getter to query how far a throws clause should be indented when on next line.
`void`	`indentationLog(int line, java.lang.String key, java.lang.Object... args)` Log a violation message.
`boolean`	`isForceStrictCondition()` Getter to query strict indent level in line wrapping case.
`void`	`leaveToken(DetailAST ast)` Called after all the child nodes have been process.
`void`	`setArrayInitIndent(int arrayInitIndent)` Setter to specify how far an array initialisation should be indented when on next line.
`void`	`setBasicOffset(int basicOffset)` Setter to specify how far new indentation level should be indented when on the next line.
`void`	`setBraceAdjustment(int adjustmentAmount)` Setter to specify how far a braces should be indented when on the next line.
`void`	`setCaseIndent(int amount)` Setter to specify how far a case label should be indented when on next line.
`void`	`setForceStrictCondition(boolean value)` Setter to force strict indent level in line wrapping case.
`void`	`setLineWrappingIndentation(int lineWrappingIndentation)` Setter to specify how far continuation line should be indented when line-wrapping is present.
`void`	`setThrowsIndent(int throwsIndent)` Setter to specify how far a throws clause should be indented when on next line.
`void`	`visitToken(DetailAST ast)` Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MSG_ERROR
```
public static final java.lang.String MSG_ERROR
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
  - MSG_ERROR_MULTI
```
public static final java.lang.String MSG_ERROR_MULTI
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
  - MSG_CHILD_ERROR
```
public static final java.lang.String MSG_CHILD_ERROR
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
  - MSG_CHILD_ERROR_MULTI
```
public static final java.lang.String MSG_CHILD_ERROR_MULTI
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IndentationCheck
```
public IndentationCheck()
```
- Method Detail
  - isForceStrictCondition
```
public boolean isForceStrictCondition()
```
    Getter to query strict indent level in line wrapping case. If value is true, line wrap indent have to be same as lineWrappingIndentation parameter. If value is false, line wrap indent could be bigger on any value user would like.
    
    Returns:
    
    forceStrictCondition value.
  - setForceStrictCondition
```
public void setForceStrictCondition(boolean value)
```
    Setter to force strict indent level in line wrapping case. If value is true, line wrap indent have to be same as lineWrappingIndentation parameter. If value is false, line wrap indent could be bigger on any value user would like.
    
    Parameters:
    
    value - user's value of forceStrictCondition.
  - setBasicOffset
```
public void setBasicOffset(int basicOffset)
```
    Setter to specify how far new indentation level should be indented when on the next line.
    
    Parameters:
    
    basicOffset - the number of tabs or spaces to indent
  - getBasicOffset
```
public int getBasicOffset()
```
    Getter to query how far new indentation level should be indented when on the next line.
    
    Returns:
    
    the number of tabs or spaces to indent
  - setBraceAdjustment
```
public void setBraceAdjustment(int adjustmentAmount)
```
    Setter to specify how far a braces should be indented when on the next line.
    
    Parameters:
    
    adjustmentAmount - the brace offset
  - getBraceAdjustment
```
public int getBraceAdjustment()
```
    Getter to query how far a braces should be indented when on the next line.
    
    Returns:
    
    the positive offset to adjust braces
  - setCaseIndent
```
public void setCaseIndent(int amount)
```
    Setter to specify how far a case label should be indented when on next line.
    
    Parameters:
    
    amount - the case indentation level
  - getCaseIndent
```
public int getCaseIndent()
```
    Getter to query how far a case label should be indented when on next line.
    
    Returns:
    
    the case indentation level
  - setThrowsIndent
```
public void setThrowsIndent(int throwsIndent)
```
    Setter to specify how far a throws clause should be indented when on next line.
    
    Parameters:
    
    throwsIndent - the throws indentation level
  - getThrowsIndent
```
public int getThrowsIndent()
```
    Getter to query how far a throws clause should be indented when on next line.
    
    Returns:
    
    the throws indentation level
  - setArrayInitIndent
```
public void setArrayInitIndent(int arrayInitIndent)
```
    Setter to specify how far an array initialisation should be indented when on next line.
    
    Parameters:
    
    arrayInitIndent - the array initialisation indentation level
  - getArrayInitIndent
```
public int getArrayInitIndent()
```
    Getter to query how far an array initialisation should be indented when on next line.
    
    Returns:
    
    the initialisation indentation level
  - getLineWrappingIndentation
```
public int getLineWrappingIndentation()
```
    Getter to query how far continuation line should be indented when line-wrapping is present.
    
    Returns:
    
    the line-wrapping indentation level
  - setLineWrappingIndentation
```
public void setLineWrappingIndentation(int lineWrappingIndentation)
```
    Setter to specify how far continuation line should be indented when line-wrapping is present.
    
    Parameters:
    
    lineWrappingIndentation - the line-wrapping indentation level
  - indentationLog
```
public void indentationLog(int line,
                           java.lang.String key,
                           java.lang.Object... args)
```
    Log a violation message.
    
    Parameters:
    
    line - the line number where the violation was found
    
    key - the message that describes the violation
    
    args - the details of the message
    
    See Also:
    
    MessageFormat
  - getIndentationTabWidth
```
public int getIndentationTabWidth()
```
    Get the width of a tab.
    
    Returns:
    
    the width of a tab
  - getDefaultTokens
```
public int[] getDefaultTokens()
```
    Description copied from class: AbstractCheck
    
    Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
    
    Specified by:
    
    getDefaultTokens in class AbstractCheck
    
    Returns:
    
    the default tokens
    
    See Also:
    
    TokenTypes
  - getAcceptableTokens
```
public int[] getAcceptableTokens()
```
    Description copied from class: AbstractCheck
    
    The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
    
    Specified by:
    
    getAcceptableTokens in class AbstractCheck
    
    Returns:
    
    the token set this check is designed for.
    
    See Also:
    
    TokenTypes
  - getRequiredTokens
```
public int[] getRequiredTokens()
```
    Description copied from class: AbstractCheck
    
    The tokens that this check must be registered for.
    
    Specified by:
    
    getRequiredTokens in class AbstractCheck
    
    Returns:
    
    the token set this must be registered for.
    
    See Also:
    
    TokenTypes
  - beginTree
```
public void beginTree(DetailAST ast)
```
    Description copied from class: AbstractCheck
    
    Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
    
    Overrides:
    
    beginTree in class AbstractCheck
    
    Parameters:
    
    ast - the root of the tree
  - visitToken
```
public void visitToken(DetailAST ast)
```
    Description copied from class: AbstractCheck
    
    Called to process a token.
    
    Overrides:
    
    visitToken in class AbstractCheck
    
    Parameters:
    
    ast - the token to process
  - leaveToken
```
public void leaveToken(DetailAST ast)
```
    Description copied from class: AbstractCheck
    
    Called after all the child nodes have been process.
    
    Overrides:
    
    leaveToken in class AbstractCheck
    
    Parameters:
    
    ast - the token leaving
  - getLineWrappingHandler
```
public LineWrappingHandler getLineWrappingHandler()
```
    Accessor for the line wrapping handler.
    
    Returns:
    
    the line wrapping handler
  - getHandlerFactory
```
public final HandlerFactory getHandlerFactory()
```
    Accessor for the handler factory.
    
    Returns:
    
    the handler factory

Class IndentationCheck

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Methods inherited from class java.lang.Object

Field Detail

MSG_ERROR

MSG_ERROR_MULTI

MSG_CHILD_ERROR

MSG_CHILD_ERROR_MULTI

Constructor Detail

IndentationCheck

Method Detail

isForceStrictCondition

setForceStrictCondition

setBasicOffset

getBasicOffset

setBraceAdjustment

getBraceAdjustment

setCaseIndent

getCaseIndent

setThrowsIndent

getThrowsIndent

setArrayInitIndent

getArrayInitIndent

getLineWrappingIndentation

setLineWrappingIndentation

indentationLog

getIndentationTabWidth

getDefaultTokens

getAcceptableTokens

getRequiredTokens

beginTree

visitToken

leaveToken

getLineWrappingHandler

getHandlerFactory