Package org.ametys.cms.search.query

Enum CommentQuery.CommentInclusion

java.lang.Object

java.lang.Enum<CommentQuery.CommentInclusion>

org.ametys.cms.search.query.CommentQuery.CommentInclusion

All Implemented Interfaces:

Serializable, Comparable<CommentQuery.CommentInclusion>

Enclosing class:

CommentQuery

public static enum CommentQuery.CommentInclusion
extends Enum<CommentQuery.CommentInclusion>

The type (validated, non validated or both) of comments to include for CommentQuery

Enum Constant Summary

Enum Constants

Enum Constant	Description
NON_VALIDATED	Request only contents with non validated-comments
VALIDATED	Request only contents with validated comments
VALIDATED_AND_NON_VALIDATED	Request only contents with both validated and non-validated comments

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CommentInclusion()

Method Summary

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

VALIDATED_AND_NON_VALIDATED

public static final CommentQuery.CommentInclusion VALIDATED_AND_NON_VALIDATED

Request only contents with both validated and non-validated comments

VALIDATED

public static final CommentQuery.CommentInclusion VALIDATED

Request only contents with validated comments

NON_VALIDATED

public static final CommentQuery.CommentInclusion NON_VALIDATED

Request only contents with non validated-comments

Constructor Detail

CommentInclusion

private CommentInclusion()

Method Detail

values

public static CommentQuery.CommentInclusion[] 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 (CommentQuery.CommentInclusion c : CommentQuery.CommentInclusion.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommentQuery.CommentInclusion 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