Package org.azd.enums

Enum Class CommentExpandOptions

java.lang.Object

java.lang.Enum<CommentExpandOptions>

org.azd.enums.CommentExpandOptions

All Implemented Interfaces:

Serializable, Comparable<CommentExpandOptions>, Constable

public enum CommentExpandOptions
extends Enum<CommentExpandOptions>

Specifies the additional data retrieval options for work item comments.

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
all
none
reactions	Include comment reactions.
renderedText	Include the rendered text (html) in addition to MD text.
renderedTextOnly	If specified, then ONLY rendered text (html) will be returned, w/o markdown.

Method Summary

Modifier and Type	Method	Description
static CommentExpandOptions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommentExpandOptions[]	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

none

public static final CommentExpandOptions none

reactions

public static final CommentExpandOptions reactions

Include comment reactions.

renderedText

public static final CommentExpandOptions renderedText

Include the rendered text (html) in addition to MD text.

renderedTextOnly

public static final CommentExpandOptions renderedTextOnly

If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes.

all

public static final CommentExpandOptions all

Method Details

values

public static CommentExpandOptions[] 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 CommentExpandOptions 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