com.cloudera.gertrude

Class ExperimentFlag<T>

java.lang.Object

com.cloudera.gertrude.ExperimentFlag<T>

public final class ExperimentFlag<T>
extends Object

A named, typed parameter whose value for an ExperimentState can change depending on the experiments that the ExperimentState has been diverted into.

Instances of this class are created via the static factory methods defined in the Experiments namespace:

 ExperimentFlag<Double> foo = Experiments.declare("foo_param", 17.29);
   ExperimentFlag<Long> bar = Experiments.declare("bar_field", 13);
   ExperimentFlag<String> baz = Experiments.declare("baz", "");

The value of an ExperimentFlag for a request is retrieved from an ExperimentState:

 ExperimentState myState = ...;
   double fooValue = myState.get(foo);
   float fooFloat = myState.getFloat(foo);
   long barValue = myState.get(bar);
   int barInt = myState.getInt(bar);
   String bazStr = myState.get(baz);

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
T	getDefaultValue() Returns the default value of this flag, which is what will be returned when a call to ExperimentState.get(ExperimentFlag) is made before the ExperimentState has been diverted by the ExperimentHandler.
String	getName() Returns the name of this experiment flag, which should correspond to the name of a parameter defined in the ExperimentSpace.
int	hashCode()
T	parse(String value) Converts the given string into an instance of the type T of this flag.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Returns the name of this experiment flag, which should correspond to the name of a parameter defined in the ExperimentSpace.

Returns:

the name of this flag

parse

public T parse(String value)

Converts the given string into an instance of the type T of this flag.

Parameters:

value - the string form of the value

Returns:

the value as an instance of type T

getDefaultValue

public T getDefaultValue()

Returns the default value of this flag, which is what will be returned when a call to ExperimentState.get(ExperimentFlag) is made before the ExperimentState has been diverted by the ExperimentHandler.

Returns:

the default value of this flag

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object