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

Enum JavadocContentLocationOption

java.lang.Object

java.lang.Enum<JavadocContentLocationOption>

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption

All Implemented Interfaces:

Serializable, Comparable<JavadocContentLocationOption>

public enum JavadocContentLocationOption
extends Enum<JavadocContentLocationOption>

Represents the locations for the javadoc content.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST_LINE	Represents a policy for the location of content starting from the same line as /**.
SECOND_LINE	Represents a policy for the location of content starting from the next line after /**.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavadocContentLocationOption()

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST_LINE

public static final JavadocContentLocationOption FIRST_LINE

Represents a policy for the location of content starting from the same line as /**. Example:

 /** Summary text.
   * More details.
   */
 public void method();
 

This style is also known as "scala" style.

SECOND_LINE

public static final JavadocContentLocationOption SECOND_LINE

Represents a policy for the location of content starting from the next line after /**. Example:

 /**
  * Summary text.
  * More details.
  */
 public void method();
 

This style is common to java projects.

Constructor Detail

JavadocContentLocationOption

private JavadocContentLocationOption()

Method Detail

values

public static JavadocContentLocationOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JavadocContentLocationOption c : JavadocContentLocationOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavadocContentLocationOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null