com.atlassian.confluence.search.v2

Enum ScoringStrategy

java.lang.Object

java.lang.Enum<ScoringStrategy>

com.atlassian.confluence.search.v2.ScoringStrategy

All Implemented Interfaces:

Serializable, Comparable<ScoringStrategy>

public enum ScoringStrategy
extends Enum<ScoringStrategy>

This enum contains all supported scoring strategies for index. A scoring strategy determines which Similarity instance is used for the searcher of an index. If no scoring strategy or the DEFAULT scoring strategy is provided, then no custom Similarity instance will be used (for the searcher) See CustomLuceneConnectionFactoryImpl for the implementation details.

Since:

7.17

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
EDGE

Method Summary

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

DEFAULT

public static final ScoringStrategy DEFAULT

EDGE

public static final ScoringStrategy EDGE

Method Detail

values

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

Returns:

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

valueOf

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