Package io.unlaunch

Class UnlaunchFeature

java.lang.Object

io.unlaunch.UnlaunchFeature

public class UnlaunchFeature
extends Object

This class wraps the result of a feature flag evaluation. It makes all evaluation data available in one class, including:

• Variation: This is the variation (key) that you defined e.g. "on", "off", etc.
• Configuration: Key-Value or JSON Configuration that you attached to your variation.
• Evaluation Reason: Flag evaluation reason on why certain variation ws returned. Useful for debugging.

Use this class if you want to retrieve Configuration attached to variation or get the Evaluation Reason. If you just want to retrieve variation, you can also use the (shortcut) UnlaunchClient.getVariation(String, String) method.

Author:

umermansoor

Method Summary

Modifier and Type	Method	Description
static UnlaunchFeature	create(String flagKey, String variationKey, Map<String,String> properties)
static UnlaunchFeature	create(String flagKey, String variationKey, Map<String,String> properties, String evaluationReason)
String	getEvaluationReason()	Provides a detailed evaluation reason as to why the variation (result of getVariation()) was chosen.
String	getFlag()	Returns the key of the flag this was evaluated for.
String	getVariation()	Evaluates and returns the variation (variation key) for this feature.
UnlaunchDynamicConfig	getVariationConfig()	Returns UnlaunchDynamicConfig object which contains configuration (Key-Value) that you attached to the variation in the Unlaunch Console.
Map<String,String>	getVariationConfigAsMap()	Returns Key-Value configuration as a Map that you defined in the Unlaunch Console using the "Configuration" tab on the feature flag details page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFlag

public String getFlag()

Returns the key of the flag this was evaluated for.

Returns:

flag key for this evaluation

getVariation

public String getVariation()

Evaluates and returns the variation (variation key) for this feature. Variations are defined using the Unlaunch Console at https://app.unlaunch.io.

This method returns "control" if:

1. The flag was not found.
2. There was an exception evaluation the feature flag.
3. The flag was archived.

This method doesn't throw any exceptions nor does it return null value

Returns:

the evaluated variation or "control" if there was an error.

getVariationConfigAsMap

public Map<String,String> getVariationConfigAsMap()

Returns Key-Value configuration as a Map that you defined in the Unlaunch Console using the "Configuration" tab on the feature flag details page.

Returns:

Map of Key-Value configuration for the evaluated variation.

getVariationConfig

public UnlaunchDynamicConfig getVariationConfig()

Returns UnlaunchDynamicConfig object which contains configuration (Key-Value) that you attached to the variation in the Unlaunch Console. You can use either this or the getVariationConfigAsMap() method to get Configuration depending on what you prefer.

Returns:

UnlaunchDynamicConfig for configuration (Key-Value)

getEvaluationReason

public String getEvaluationReason()

Provides a detailed evaluation reason as to why the variation (result of getVariation()) was chosen. This is useful for debugging and troubleshooting when you are wondering why you're not getting the variation that you were expecting.

For example, if you were expecting the "on" variation, but getting "off" variation, check why "off" is being selected using this method.

Tip: You can also check evaluation reason and view evaluations in real-time using the "Live Tail" feature of the Unlaunch Console. To access the Unlaunch Console, visit https://app.unlaunch.io.

Returns:

evaluation reason (as String) explaining why the variation was selected

create

public static UnlaunchFeature create(String flagKey,
                                     String variationKey,
                                     Map<String,String> properties,
                                     String evaluationReason)

create

public static UnlaunchFeature create(String flagKey,
                                     String variationKey,
                                     Map<String,String> properties)