com.puppycrawl.tools.checkstyle.checks.indentation

Class IndentLevel

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel

public class IndentLevel
extends java.lang.Object

Encapsulates representation of notion of expected indentation levels. Provide a way to have multiple acceptable levels. This class is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.BitSet	levels Set of acceptable indentation levels.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IndentLevel() Creates new instance with no acceptable indentation level.
	IndentLevel(IndentLevel base, int... offsets) Creates new instance for nested structure.
	IndentLevel(int indent) Creates new instance with one acceptable indentation level.

Method Summary

Modifier and Type	Method and Description
static IndentLevel	addAcceptable(IndentLevel base, IndentLevel addition) Combines 2 acceptable indentation level classes.
static IndentLevel	addAcceptable(IndentLevel base, int... additions) Adds one or more acceptable indentation level.
int	getFirstIndentLevel() Returns first indentation level.
int	getLastIndentLevel() Returns last indentation level.
boolean	isAcceptable(int indent) Checks if given indentation is acceptable.
boolean	isGreaterThan(int indent) Returns true if indent less than minimal of acceptable indentation levels, false otherwise.
boolean	isMultiLevel() Checks whether we have more than one level.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

levels

private final java.util.BitSet levels

Set of acceptable indentation levels.

Constructor Detail

IndentLevel

public IndentLevel(int indent)

Creates new instance with one acceptable indentation level.

Parameters:

indent - acceptable indentation level.

IndentLevel

public IndentLevel(IndentLevel base,
                   int... offsets)

Creates new instance for nested structure.

Parameters:

base - parent's level

offsets - offsets from parent's level.

IndentLevel

private IndentLevel()

Creates new instance with no acceptable indentation level. This is only used internally to combine multiple levels.

Method Detail

isMultiLevel

public final boolean isMultiLevel()

Checks whether we have more than one level.

Returns:

whether we have more than one level.

isAcceptable

public boolean isAcceptable(int indent)

Checks if given indentation is acceptable.

Parameters:

indent - indentation to check.

Returns:

true if given indentation is acceptable, false otherwise.

isGreaterThan

public boolean isGreaterThan(int indent)

Returns true if indent less than minimal of acceptable indentation levels, false otherwise.

Parameters:

indent - indentation to check.

Returns:

true if indent less than minimal of acceptable indentation levels, false otherwise.

addAcceptable

public static IndentLevel addAcceptable(IndentLevel base,
                                        int... additions)

Adds one or more acceptable indentation level.

Parameters:

base - class to add new indentations to.

additions - new acceptable indentation.

Returns:

New acceptable indentation level instance.

addAcceptable

public static IndentLevel addAcceptable(IndentLevel base,
                                        IndentLevel addition)

Combines 2 acceptable indentation level classes.

Parameters:

base - class to add new indentations to.

addition - new acceptable indentation.

Returns:

New acceptable indentation level instance.

getFirstIndentLevel

public int getFirstIndentLevel()

Returns first indentation level.

Returns:

indentation level.

getLastIndentLevel

public int getLastIndentLevel()

Returns last indentation level.

Returns:

indentation level.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object