com.puppycrawl.tools.checkstyle.checks.blocks

Class LeftCurlyOption

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.AbstractOption

com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption

All Implemented Interfaces:

Serializable

public final class LeftCurlyOption
extends AbstractOption

Represents the options for placing the left curly brace '{'.

Version:

1

Author:

Oliver Burn

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LeftCurlyOption	EOL Represents the policy for placing the brace at the end of line.
static LeftCurlyOption	NL Represents the policy that the brace must always be on a new line.
static LeftCurlyOption	NLOW Represents the policy that if the brace will fit on the first line of the statement, taking into account maximum line length, then apply EOL rule.

Method Summary

Methods

Modifier and Type	Method and Description
protected Map	getStrToOpt() Returns the map from string representations to options.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOption

decode, readResolve, toString

Methods inherited from class java.lang.Object

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

Field Detail

EOL

public static final LeftCurlyOption EOL

Represents the policy for placing the brace at the end of line. For example:

 if (condition) {
     ...
 

NLOW

public static final LeftCurlyOption NLOW

Represents the policy that if the brace will fit on the first line of the statement, taking into account maximum line length, then apply EOL rule. Otherwise apply the NL rule. NLOW is a mnemonic for "new line on wrap".

For the example above Checkstyle will enforce:

 if (condition) {
     ...
 

But for a statement spanning multiple lines, Checkstyle will enforce:

 if (condition1 && condition2 &&
     condition3 && condition4)
 {
     ...
 

NL

public static final LeftCurlyOption NL

Represents the policy that the brace must always be on a new line. For example:

 if (condition)
 {
     ...
 

Method Detail

getStrToOpt

protected Map getStrToOpt()

Returns the map from string representations to options.

Specified by:

getStrToOpt in class AbstractOption

Returns:

Map from strings to options.