net.lenni0451.commons.strings.search

Enum ResultFilter

java.lang.Object

java.lang.Enum<ResultFilter>

net.lenni0451.commons.strings.search.ResultFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResultFilter>

public enum ResultFilter
extends java.lang.Enum<ResultFilter>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Return all results sorted by the score.
GAP Filter the search results by the gap between the lowest and the highest score.
HIGHEST Only return the highest scored results.

Method Summary

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

ALL

public static final ResultFilter ALL

Return all results sorted by the score.
The best result will be the first one.

GAP

public static final ResultFilter GAP

Filter the search results by the gap between the lowest and the highest score.
Calculation: filter(result -> result.score >= minScore + ceil((maxScore - minScore) / 2F)

HIGHEST

public static final ResultFilter HIGHEST

Only return the highest scored results.

Method Detail

values

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

Returns:

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

valueOf

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