Enum Class ErrorProneComment.ErrorProneCommentStyle

java.lang.Object

java.lang.Enum<ErrorProneComment.ErrorProneCommentStyle>

com.google.errorprone.util.ErrorProneComment.ErrorProneCommentStyle

All Implemented Interfaces:

Serializable, Comparable<ErrorProneComment.ErrorProneCommentStyle>, Constable

Enclosing class:

ErrorProneComment

public static enum ErrorProneComment.ErrorProneCommentStyle
extends Enum<ErrorProneComment.ErrorProneCommentStyle>

A compatibility wrapper for Tokens.Comment.CommentStyle.

Directly using Tokens.Comment.CommentStyle would make Error Prone incompatible with older versions of javac (which only have LINE, BLOCK, and JAVADOC) and newer versions (which add JAVADOC_LINE and rename JAVADOC to JAVADOC_BLOCK).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK
JAVADOC_BLOCK
JAVADOC_LINE
LINE

Method Summary

Modifier and Type	Method	Description
static ErrorProneComment.ErrorProneCommentStyle	from(com.sun.tools.javac.parser.Tokens.Comment.CommentStyle style)	Returns the ErrorProneComment.ErrorProneCommentStyle for the given Tokens.Comment.CommentStyle.
static ErrorProneComment.ErrorProneCommentStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErrorProneComment.ErrorProneCommentStyle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LINE

public static final ErrorProneComment.ErrorProneCommentStyle LINE

BLOCK

public static final ErrorProneComment.ErrorProneCommentStyle BLOCK

JAVADOC_LINE

public static final ErrorProneComment.ErrorProneCommentStyle JAVADOC_LINE

JAVADOC_BLOCK

public static final ErrorProneComment.ErrorProneCommentStyle JAVADOC_BLOCK

Method Details

values

public static ErrorProneComment.ErrorProneCommentStyle[] 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 ErrorProneComment.ErrorProneCommentStyle 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

from

public static ErrorProneComment.ErrorProneCommentStyle from(com.sun.tools.javac.parser.Tokens.Comment.CommentStyle style)

Returns the ErrorProneComment.ErrorProneCommentStyle for the given Tokens.Comment.CommentStyle.