com.optimizely.ab.bucketing

Class Bucketer

java.lang.Object

com.optimizely.ab.bucketing.Bucketer

@Immutable
public class Bucketer
extends java.lang.Object

Default Optimizely bucketing algorithm that evenly distributes users using the Murmur3 hash of some provided identifier.

The user identifier must be provided in the first data argument passed to bucket(Experiment, String, ProjectConfig) and must be non-null and non-empty.

See Also:

MurmurHash

Constructor Summary

Constructors

Constructor and Description
Bucketer()

Method Summary

Modifier and Type	Method and Description
DecisionResponse<Variation>	bucket(Experiment experiment, java.lang.String bucketingId, ProjectConfig projectConfig) Assign a Variation of an Experiment to a user based on hashed value from murmurhash3.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucketer

public Bucketer()

Method Detail

bucket

@Nonnull
public DecisionResponse<Variation> bucket(@Nonnull
                                                   Experiment experiment,
                                                   @Nonnull
                                                   java.lang.String bucketingId,
                                                   @Nonnull
                                                   ProjectConfig projectConfig)

Assign a Variation of an Experiment to a user based on hashed value from murmurhash3.

Parameters:

experiment - The Experiment in which the user is to be bucketed.

bucketingId - string A customer-assigned value used to create the key for the murmur hash.

projectConfig - The current projectConfig

Returns:

A DecisionResponse including the Variation that user is bucketed into (or null) and the decision reasons