net.cnri.repository.search

Enum BooleanClause.Occur

java.lang.Object

java.lang.Enum<BooleanClause.Occur>

net.cnri.repository.search.BooleanClause.Occur

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BooleanClause.Occur>

Enclosing class:

BooleanClause

public static enum BooleanClause.Occur
extends java.lang.Enum<BooleanClause.Occur>

Enumerated type of occurence markers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MUST Marker for subqueries which must occur for the containing query to match.
MUST_NOT Marker for subqueries which must not occur for the containing query to match.
SHOULD Marker for subqueries at least one of which must occur (if there are any) for the containing query to match.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MUST

public static final BooleanClause.Occur MUST

Marker for subqueries which must occur for the containing query to match.

MUST_NOT

public static final BooleanClause.Occur MUST_NOT

Marker for subqueries which must not occur for the containing query to match.

SHOULD

public static final BooleanClause.Occur SHOULD

Marker for subqueries at least one of which must occur (if there are any) for the containing query to match.

Method Detail

values

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

Returns:

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

valueOf

public static BooleanClause.Occur valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null