EvaluationReason (launchdarkly-android-client-sdk 2.12.0 API)

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

Direct Known Subclasses:

EvaluationReason.Error, EvaluationReason.Fallthrough, EvaluationReason.Off, EvaluationReason.PrerequisiteFailed, EvaluationReason.RuleMatch, EvaluationReason.TargetMatch, EvaluationReason.Unknown
```
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, Boolean).
Note that this is an enum-like class hierarchy rather than an enum, because some of the possible reasons have their own properties.

Since:

2.7.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EvaluationReason.Error` Subclass of `EvaluationReason` that indicates that the flag could not be evaluated.
`static class`	`EvaluationReason.ErrorKind` Enumerated type defining the possible values of `EvaluationReason.Error.getErrorKind()`.
`static class`	`EvaluationReason.Fallthrough` Subclass of `EvaluationReason` that indicates that the flag was on but the user did not match any targets or rules.
`static class`	`EvaluationReason.Kind` Enumerated type defining the possible values of `getKind()`.
`static class`	`EvaluationReason.Off` Subclass of `EvaluationReason` that indicates that the flag was off and therefore returned its configured off value.
`static class`	`EvaluationReason.PrerequisiteFailed` Subclass of `EvaluationReason` that indicates that the flag was considered off because it had at least one prerequisite flag that either was off or did not return the desired variation.
`static class`	`EvaluationReason.RuleMatch` Subclass of `EvaluationReason` that indicates that the user matched one of the flag's rules.
`static class`	`EvaluationReason.TargetMatch` Subclass of `EvaluationReason` that indicates that the user key was specifically targeted for this flag.
`static class`	`EvaluationReason.Unknown` Subclass of `EvaluationReason` that indicates that the server sent a reason that is not supported by this version of the SDK.

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 of `Error`.
`static EvaluationReason.Fallthrough`	`fallthrough()` Returns an instance of `EvaluationReason.Fallthrough`.
`EvaluationReason.Kind`	`getKind()` Returns an enum indicating the general category of the reason.
`static EvaluationReason.Off`	`off()` Returns an instance of `EvaluationReason.Off`.
`static EvaluationReason.PrerequisiteFailed`	`prerequisiteFailed(java.lang.String prerequisiteKey)` Returns an instance of `EvaluationReason.PrerequisiteFailed`.
`static EvaluationReason.RuleMatch`	`ruleMatch(int ruleIndex, java.lang.String ruleId)` Returns an instance of `EvaluationReason.RuleMatch`.
`static EvaluationReason.TargetMatch`	`targetMatch()` Returns an instance of `EvaluationReason.TargetMatch`.
`java.lang.String`	`toString()`
`static EvaluationReason.Unknown`	`unknown()` Returns an instance of `EvaluationReason.Unknown`.

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
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - off
```
public static EvaluationReason.Off off()
```
    Returns an instance of EvaluationReason.Off.
    
    Returns:
    
    a reason object
  - targetMatch
```
public static EvaluationReason.TargetMatch targetMatch()
```
    Returns an instance of EvaluationReason.TargetMatch.
    
    Returns:
    
    a reason object
  - ruleMatch
```
public static EvaluationReason.RuleMatch ruleMatch(int ruleIndex,
                                                   java.lang.String ruleId)
```
    Returns an instance of EvaluationReason.RuleMatch.
    
    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 of EvaluationReason.PrerequisiteFailed.
    
    Parameters:
    
    prerequisiteKey - the flag key of the prerequisite that failed
    
    Returns:
    
    a reason object
  - fallthrough
```
public static EvaluationReason.Fallthrough fallthrough()
```
    Returns an instance of EvaluationReason.Fallthrough.
    
    Returns:
    
    a reason object
  - error
```
public static EvaluationReason.Error error(EvaluationReason.ErrorKind errorKind)
```
    Returns an instance of Error.
    
    Parameters:
    
    errorKind - describes the type of error
    
    Returns:
    
    a reason object
  - unknown
```
public static EvaluationReason.Unknown unknown()
```
    Returns an instance of EvaluationReason.Unknown.
    
    Returns:
    
    a reason object

Class EvaluationReason

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EvaluationReason

Method Detail

getKind

toString

off

targetMatch

ruleMatch

prerequisiteFailed

fallthrough

error

unknown