com.apptimize

Class ApptimizeVar<T>

java.lang.Object

com.apptimize.ApptimizeVar<T>

Type Parameters:

T - the type of this variable (i.e., the type returned by value()).

public class ApptimizeVar<T>
extends java.lang.Object

An Apptimize variable whose value can be changed in A/B experiments.

We can create them using the create factory methods (e.g., createString(String, String), createMapOfDoubles(String, java.util.Map)).

We can get the value of an Apptimize variable using value(). This value will vary depending on what A/B experiment variants this device is currently enrolled in.

Method Summary

Methods

Modifier and Type	Method and Description
static ApptimizeVar<java.lang.Boolean>	createBoolean(java.lang.String name, java.lang.Boolean defaultValue) Creates an ApptimizeVar with a Boolean value.
static ApptimizeVar<java.lang.Double>	createDouble(java.lang.String name, java.lang.Double defaultValue) Creates an ApptimizeVar with a Double value.
static ApptimizeVar<java.lang.Integer>	createInteger(java.lang.String name, java.lang.Integer defaultValue) Creates an ApptimizeVar with an Integer value.
static ApptimizeVar<java.util.List<java.lang.Boolean>>	createListOfBooleans(java.lang.String name, java.util.List<java.lang.Boolean> defaultValue) Creates an ApptimizeVar with a List<Boolean> value.
static ApptimizeVar<java.util.List<java.lang.Double>>	createListOfDoubles(java.lang.String name, java.util.List<java.lang.Double> defaultValue) Creates an ApptimizeVar with a List<Double> value.
static ApptimizeVar<java.util.List<java.lang.Integer>>	createListOfIntegers(java.lang.String name, java.util.List<java.lang.Integer> defaultValue) Creates an ApptimizeVar with a List<Integer> value.
static ApptimizeVar<java.util.List<java.lang.String>>	createListOfStrings(java.lang.String name, java.util.List<java.lang.String> defaultValue) Creates an ApptimizeVar with a List<String> value.
static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Boolean>>	createMapOfBooleans(java.lang.String name, java.util.Map<java.lang.String,java.lang.Boolean> defaultValue) Creates an ApptimizeVar with a Map<String, Boolean> value.
static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Double>>	createMapOfDoubles(java.lang.String name, java.util.Map<java.lang.String,java.lang.Double> defaultValue) Creates an ApptimizeVar with a Map<String, Double> value.
static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Integer>>	createMapOfIntegers(java.lang.String name, java.util.Map<java.lang.String,java.lang.Integer> defaultValue) Creates an ApptimizeVar with a Map<String, Integer> value.
static ApptimizeVar<java.util.Map<java.lang.String,java.lang.String>>	createMapOfStrings(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> defaultValue) Creates an ApptimizeVar with a Map<String, String> value.
static ApptimizeVar<java.lang.String>	createString(java.lang.String name, java.lang.String defaultValue) Creates an ApptimizeVar with a String value.
boolean	equals(java.lang.Object o)
int	hashCode()
T	value() Gets the current value of this ApptimizeVar.
T	value(ApptimizeOptions options) Gets the current value of this ApptimizeVar.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

createString

public static ApptimizeVar<java.lang.String> createString(java.lang.String name,
                                          java.lang.String defaultValue)

Creates an ApptimizeVar with a String value.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<String>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createInteger

public static ApptimizeVar<java.lang.Integer> createInteger(java.lang.String name,
                                            java.lang.Integer defaultValue)

Creates an ApptimizeVar with an Integer value.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Integer>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createDouble

public static ApptimizeVar<java.lang.Double> createDouble(java.lang.String name,
                                          java.lang.Double defaultValue)

Creates an ApptimizeVar with a Double value.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Double>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createBoolean

public static ApptimizeVar<java.lang.Boolean> createBoolean(java.lang.String name,
                                            java.lang.Boolean defaultValue)

Creates an ApptimizeVar with a Boolean value.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Boolean>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createListOfStrings

public static ApptimizeVar<java.util.List<java.lang.String>> createListOfStrings(java.lang.String name,
                                                                 java.util.List<java.lang.String> defaultValue)

Creates an ApptimizeVar with a List<String> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<List<String>>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createListOfIntegers

public static ApptimizeVar<java.util.List<java.lang.Integer>> createListOfIntegers(java.lang.String name,
                                                                   java.util.List<java.lang.Integer> defaultValue)

Creates an ApptimizeVar with a List<Integer> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<List<Integer>>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createListOfDoubles

public static ApptimizeVar<java.util.List<java.lang.Double>> createListOfDoubles(java.lang.String name,
                                                                 java.util.List<java.lang.Double> defaultValue)

Creates an ApptimizeVar with a List<Double> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<List<Double>>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createListOfBooleans

public static ApptimizeVar<java.util.List<java.lang.Boolean>> createListOfBooleans(java.lang.String name,
                                                                   java.util.List<java.lang.Boolean> defaultValue)

Creates an ApptimizeVar with a List<Boolean> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<List<Boolean>>.

Throws:

java.lang.NullPointerException - If the specified name is null.

createMapOfStrings

public static ApptimizeVar<java.util.Map<java.lang.String,java.lang.String>> createMapOfStrings(java.lang.String name,
                                                                                java.util.Map<java.lang.String,java.lang.String> defaultValue)

Creates an ApptimizeVar with a Map<String, String> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Map<String, String>> .

Throws:

java.lang.NullPointerException - If the specified name is null.

createMapOfIntegers

public static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Integer>> createMapOfIntegers(java.lang.String name,
                                                                                  java.util.Map<java.lang.String,java.lang.Integer> defaultValue)

Creates an ApptimizeVar with a Map<String, Integer> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Map<String, Integer>> .

Throws:

java.lang.NullPointerException - If the specified name is null.

createMapOfDoubles

public static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Double>> createMapOfDoubles(java.lang.String name,
                                                                                java.util.Map<java.lang.String,java.lang.Double> defaultValue)

Creates an ApptimizeVar with a Map<String, Double> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Map<String, Double>> .

Throws:

java.lang.NullPointerException - If the specified name is null.

createMapOfBooleans

public static ApptimizeVar<java.util.Map<java.lang.String,java.lang.Boolean>> createMapOfBooleans(java.lang.String name,
                                                                                  java.util.Map<java.lang.String,java.lang.Boolean> defaultValue)

Creates an ApptimizeVar with a Map<String, Boolean> value.

Note that when the ApptimizeVar is created, its default value will be set to a copy of the input defaultValue rather than to the original object. Any subsequent changes to the original input object will not modify the default value of the returned ApptimizeVar.

Parameters:

name - The name of this ApptimizeVar, as it will appear when configuring A/B experiments at https://apptimize.com/admin/

defaultValue - The value of this ApptimizeVar if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The created ApptimizeVar<Map<String, Boolean>> .

Throws:

java.lang.NullPointerException - If the specified name is null.

value

public T value(ApptimizeOptions options)

Gets the current value of this ApptimizeVar. This value will vary depending on what A/B experiment variants this device is currently enrolled in. If this device is not enrolled in any A/B experiments that affect this ApptimizeVar, this method will return the default value of this ApptimizeVar. Note that if you call this method and perform modifications on the returned value, subsequent calls to this method will return new objects without these modifications. Options can be configured using the input ApptimizeOptions.

Parameters:

options - Options for configuring this method. See ApptimizeOptions

Returns:

The current value of this ApptimizeVar for this device.

value

public T value()

Gets the current value of this ApptimizeVar. This value will vary depending on what A/B experiment variants this device is currently enrolled in. If this device is not enrolled in any A/B experiments that affect this ApptimizeVar, this method will return the default value of this ApptimizeVar. Note that even if you call this method and perform modifications on the returned value, subsequent calls to this method will still return new objects without these modifications.

Returns:

The current value of this ApptimizeVar for this device.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object