FieldValueFactorFunction.Modifier (Atlassian Confluence 8.5.7 API)

java.lang.Object
- java.lang.Enum<FieldValueFactorFunction.Modifier>
- - com.atlassian.confluence.search.v2.score.FieldValueFactorFunction.Modifier

All Implemented Interfaces:

Serializable, Comparable<FieldValueFactorFunction.Modifier>

Enclosing class:

FieldValueFactorFunction
```
public static enum FieldValueFactorFunction.Modifier
extends Enum<FieldValueFactorFunction.Modifier>
```
The Type class encapsulates the modification types that can be applied to the score/value product.

Enum Constant Summary

Enum Constants
Enum Constant Description

LN

LN1P

LN2P

LOG

LOG1P

LOG2P

NONE

RECIPROCAL

SQRT

SQUARE

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract double`	`apply(double n)`
`static FieldValueFactorFunction.Modifier`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FieldValueFactorFunction.Modifier[]`	`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

NONE

public static final FieldValueFactorFunction.Modifier NONE

LOG

public static final FieldValueFactorFunction.Modifier LOG

LOG1P

public static final FieldValueFactorFunction.Modifier LOG1P

LOG2P

public static final FieldValueFactorFunction.Modifier LOG2P

LN

public static final FieldValueFactorFunction.Modifier LN

LN1P

public static final FieldValueFactorFunction.Modifier LN1P

LN2P

public static final FieldValueFactorFunction.Modifier LN2P

SQUARE

public static final FieldValueFactorFunction.Modifier SQUARE

SQRT

public static final FieldValueFactorFunction.Modifier SQRT

RECIPROCAL

public static final FieldValueFactorFunction.Modifier RECIPROCAL

Method Detail
- values
```
public static FieldValueFactorFunction.Modifier[] 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 (FieldValueFactorFunction.Modifier c : FieldValueFactorFunction.Modifier.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static FieldValueFactorFunction.Modifier 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
- apply
```
public abstract double apply(double n)
```