Module dev.openfeature.sdk
Package dev.openfeature.sdk

Interface BaseEvaluation<T>

Type Parameters:
T - The type of flag being evaluated.
All Known Implementing Classes:
FlagEvaluationDetails, ProviderEvaluation
public interface BaseEvaluation<T>
This is a common interface between the evaluation results that providers return and what is given to the end users.

  • Method Summary

    Modifier and Type
    Method
    Description
    ErrorCode
    getErrorCode()
    The error code, if applicable.
    String
    getErrorMessage()
    The error message (usually from exception.getMessage()), if applicable.
    String
    getReason()
    Describes how we came to the value that we're returning.
    T
    getValue()
    Returns the resolved value of the evaluation.
    String
    getVariant()
    Returns an identifier for this value, if applicable.

  • Method Details

    • getValue

      T getValue()
      Returns the resolved value of the evaluation.
      Returns:
      {T} the resolve value

    • getVariant

      String getVariant()
      Returns an identifier for this value, if applicable.
      Returns:
      {String} value identifier

    • getReason

      String getReason()
      Describes how we came to the value that we're returning.
      Returns:
      {Reason}

    • getErrorCode

      ErrorCode getErrorCode()
      The error code, if applicable. Should only be set when the Reason is ERROR.
      Returns:
      {ErrorCode}

    • getErrorMessage

      String getErrorMessage()
      The error message (usually from exception.getMessage()), if applicable. Should only be set when the Reason is ERROR.
      Returns:
      {String}