Package com.puppycrawl.tools.checkstyle.checks.javadoc

Enum Class BlockCommentEndPositionOption

java.lang.Object

java.lang.Enum<BlockCommentEndPositionOption>

com.puppycrawl.tools.checkstyle.checks.javadoc.BlockCommentEndPositionOption

All Implemented Interfaces:

Serializable, Comparable<BlockCommentEndPositionOption>, Constable

public enum BlockCommentEndPositionOption
extends Enum<BlockCommentEndPositionOption>

Represents the options for the position of the block comment end. */.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALONE	Represents the policy that the block comment end must be alone on its own line.
ALONE_OR_SINGLELINE	Represents the policy that the block comment end must be alone on its own line or on the same line as the block comment begin.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlockCommentEndPositionOption()

Method Summary

Modifier and Type	Method	Description
static BlockCommentEndPositionOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlockCommentEndPositionOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALONE

public static final BlockCommentEndPositionOption ALONE

Represents the policy that the block comment end must be alone on its own line. For example:

 /**
  * Multiple lines of Javadoc text are written here,
  * wrapped normally...
  */
 public void method();
 

ALONE_OR_SINGLELINE

public static final BlockCommentEndPositionOption ALONE_OR_SINGLELINE

Represents the policy that the block comment end must be alone on its own line or on the same line as the block comment begin. For example:

 // Block comment end is alone on its own line
 /**
  * Multiple lines of Javadoc text are written here,
  * wrapped normally...
  */
 public void method();

 // Single-line Javadoc
 /** Javadoc summary. */
 public void method1();
 

Constructor Details

BlockCommentEndPositionOption

private BlockCommentEndPositionOption()

Method Details

values

public static BlockCommentEndPositionOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BlockCommentEndPositionOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null