com.atlassian.confluence.macro.query
Enum InclusionCriteria

java.lang.Object
  java.lang.Enum<InclusionCriteria>
      com.atlassian.confluence.macro.query.InclusionCriteria

All Implemented Interfaces:

Serializable, Comparable<InclusionCriteria>

public enum InclusionCriteria
extends Enum<InclusionCriteria>

Match tokens that describe what search constraint should be applied to a parsed SearchQuery.

Since:

2.9

Enum Constant Summary

ALL
Associated token must match.

ANY
Associated token should match if possible.

NONE
Associated token must not match.

Method Summary

static InclusionCriteria	get(String token) Returns the proper InclusionCriteria value corresponding to the specified token.
static InclusionCriteria	valueOf(String name) Returns the enum constant of this type with the specified name.
static InclusionCriteria[]	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

ANY

public static final InclusionCriteria ANY

Associated token should match if possible.

ALL

public static final InclusionCriteria ALL

Associated token must match.

NONE

public static final InclusionCriteria NONE

Associated token must not match.

Method Detail

values

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

Returns:

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

valueOf

public static InclusionCriteria 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

get

public static InclusionCriteria get(String token)

Returns the proper InclusionCriteria value corresponding to the specified token. Returns null if no matching value is found.

Parameters:

token - the token to get the value for

Returns:

the value of the token, or null if none is found