EvaluationReason (launchdarkly-java-server-sdk 4.14.2 API)

java.lang.Object
- com.launchdarkly.client.EvaluationReason

Direct Known Subclasses:

EvaluationReason.Error, EvaluationReason.Fallthrough, EvaluationReason.Off, EvaluationReason.PrerequisiteFailed, EvaluationReason.RuleMatch, EvaluationReason.TargetMatch
```
public abstract class EvaluationReason
extends java.lang.Object
```
Describes the reason that a flag evaluation produced a particular value. This is returned by methods such as LDClientInterface.boolVariationDetail(String, LDUser, boolean).
Note that this is an enum-like class hierarchy rather than an enum, because some of the possible reasons have their own properties. However, directly referencing the subclasses is deprecated; in a future version only the EvaluationReason base class will be visible, and it has getter methods for all of the possible properties.

Since:

4.3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EvaluationReason.Error` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.ERROR` value.
`static class`	`EvaluationReason.ErrorKind` Enumerated type defining the possible values of `EvaluationReason.Error.getErrorKind()`.
`static class`	`EvaluationReason.Fallthrough` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.FALLTHROUGH` value.
`static class`	`EvaluationReason.Kind` Enumerated type defining the possible values of `getKind()`.
`static class`	`EvaluationReason.Off` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.OFF` value.
`static class`	`EvaluationReason.PrerequisiteFailed` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.PREREQUISITE_FAILED` value.
`static class`	`EvaluationReason.RuleMatch` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.RULE_MATCH` value.
`static class`	`EvaluationReason.TargetMatch` Deprecated. This type will be removed in a future version. Use `getKind()` instead and check for the `EvaluationReason.Kind.TARGET_MATCH` value.

Constructor Summary

Constructors
Modifier Constructor and Description

protected EvaluationReason(EvaluationReason.Kind kind)

Constructors
Modifier	Constructor and Description
`protected`	`EvaluationReason(EvaluationReason.Kind kind)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EvaluationReason.Error`	`error(EvaluationReason.ErrorKind errorKind)` Returns an instance whose `kind` is `EvaluationReason.Kind.ERROR`.
`static EvaluationReason.Error`	`exception(java.lang.Exception exception)` Returns an instance of `Error` with the kind `EvaluationReason.ErrorKind.EXCEPTION` and an exception instance.
`static EvaluationReason.Fallthrough`	`fallthrough()` Returns an instance whose `kind` is `EvaluationReason.Kind.FALLTHROUGH`.
`EvaluationReason.ErrorKind`	`getErrorKind()` An enumeration value indicating the general category of error, if the `kind` is `EvaluationReason.Kind.PREREQUISITE_FAILED`.
`java.lang.Exception`	`getException()` The exception that caused the error condition, if the `kind` is `EvaluationReason.Kind.ERROR` and the `errorKind` is `EvaluationReason.ErrorKind.EXCEPTION`.
`EvaluationReason.Kind`	`getKind()` Returns an enum indicating the general category of the reason.
`java.lang.String`	`getPrerequisiteKey()` The key of the prerequisite flag that did not return the desired variation, if the `kind` is `EvaluationReason.Kind.PREREQUISITE_FAILED`.
`java.lang.String`	`getRuleId()` The unique identifier of the rule that was matched, if the `kind` is `EvaluationReason.Kind.RULE_MATCH`.
`int`	`getRuleIndex()` The index of the rule that was matched (0 for the first rule in the feature flag), if the `kind` is `EvaluationReason.Kind.RULE_MATCH`.
`static EvaluationReason.Off`	`off()` Returns an instance whose `kind` is `EvaluationReason.Kind.OFF`.
`static EvaluationReason.PrerequisiteFailed`	`prerequisiteFailed(java.lang.String prerequisiteKey)` Returns an instance whose `kind` is `EvaluationReason.Kind.PREREQUISITE_FAILED`.
`static EvaluationReason.RuleMatch`	`ruleMatch(int ruleIndex, java.lang.String ruleId)` Returns an instance whose `kind` is `EvaluationReason.Kind.RULE_MATCH`.
`static EvaluationReason.TargetMatch`	`targetMatch()` Returns an instance whose `kind` is `EvaluationReason.Kind.TARGET_MATCH`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EvaluationReason
```
protected EvaluationReason(EvaluationReason.Kind kind)
```
- Method Detail
  - getKind
```
public EvaluationReason.Kind getKind()
```
    Returns an enum indicating the general category of the reason.
    
    Returns:
    
    a EvaluationReason.Kind value
  - getRuleIndex
```
public int getRuleIndex()
```
    The index of the rule that was matched (0 for the first rule in the feature flag), if the kind is EvaluationReason.Kind.RULE_MATCH. Otherwise this returns -1.
    
    Returns:
    
    the rule index or -1
  - getRuleId
```
public java.lang.String getRuleId()
```
    The unique identifier of the rule that was matched, if the kind is EvaluationReason.Kind.RULE_MATCH. Otherwise null.
    Unlike the rule index, this identifier will not change if other rules are added or deleted.
    
    Returns:
    
    the rule identifier or null
  - getPrerequisiteKey
```
public java.lang.String getPrerequisiteKey()
```
    The key of the prerequisite flag that did not return the desired variation, if the kind is EvaluationReason.Kind.PREREQUISITE_FAILED. Otherwise null.
    
    Returns:
    
    the prerequisite flag key or null
  - getErrorKind
```
public EvaluationReason.ErrorKind getErrorKind()
```
    An enumeration value indicating the general category of error, if the kind is EvaluationReason.Kind.PREREQUISITE_FAILED. Otherwise null.
    
    Returns:
    
    the error kind or null
  - getException
```
public java.lang.Exception getException()
```
    The exception that caused the error condition, if the kind is EvaluationReason.Kind.ERROR and the errorKind is EvaluationReason.ErrorKind.EXCEPTION. Otherwise null.
    
    Returns:
    
    the exception instance
    
    Since:
    
    4.11.0
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - off
```
public static EvaluationReason.Off off()
```
    Returns an instance whose kind is EvaluationReason.Kind.OFF.
    
    Returns:
    
    a reason object
  - targetMatch
```
public static EvaluationReason.TargetMatch targetMatch()
```
    Returns an instance whose kind is EvaluationReason.Kind.TARGET_MATCH.
    
    Returns:
    
    a reason object
  - ruleMatch
```
public static EvaluationReason.RuleMatch ruleMatch(int ruleIndex,
                                                   java.lang.String ruleId)
```
    Returns an instance whose kind is EvaluationReason.Kind.RULE_MATCH.
    
    Parameters:
    
    ruleIndex - the rule index
    
    ruleId - the rule identifier
    
    Returns:
    
    a reason object
  - prerequisiteFailed
```
public static EvaluationReason.PrerequisiteFailed prerequisiteFailed(java.lang.String prerequisiteKey)
```
    Returns an instance whose kind is EvaluationReason.Kind.PREREQUISITE_FAILED.
    
    Parameters:
    
    prerequisiteKey - the flag key of the prerequisite that failed
    
    Returns:
    
    a reason object
  - fallthrough
```
public static EvaluationReason.Fallthrough fallthrough()
```
    Returns an instance whose kind is EvaluationReason.Kind.FALLTHROUGH.
    
    Returns:
    
    a reason object
  - error
```
public static EvaluationReason.Error error(EvaluationReason.ErrorKind errorKind)
```
    Returns an instance whose kind is EvaluationReason.Kind.ERROR.
    
    Parameters:
    
    errorKind - describes the type of error
    
    Returns:
    
    a reason object
  - exception
```
public static EvaluationReason.Error exception(java.lang.Exception exception)
```
    Returns an instance of Error with the kind EvaluationReason.ErrorKind.EXCEPTION and an exception instance.
    
    Parameters:
    
    exception - the exception that caused the error
    
    Returns:
    
    a reason object
    
    Since:
    
    4.11.0

Class EvaluationReason

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EvaluationReason

Method Detail

getKind

getRuleIndex

getRuleId

getPrerequisiteKey

getErrorKind

getException

toString

off

targetMatch

ruleMatch

prerequisiteFailed

fallthrough

error

exception