Package com.indeed.proctor.common

Class ProctorResult

java.lang.Object

com.indeed.proctor.common.ProctorResult

public class ProctorResult
extends java.lang.Object

Return value from Proctor.determineTestGroups(Identifiers, java.util.Map, java.util.Map)

Field Summary

Fields

Modifier and Type	Field	Description
static ProctorResult	EMPTY

Constructor Summary

Constructors

Constructor	Description
ProctorResult(int matrixVersion, java.util.Map<java.lang.String,TestBucket> buckets, java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)	Deprecated. this constructor creates copies of all inputs
ProctorResult(java.lang.String matrixVersion, java.util.Map<java.lang.String,TestBucket> buckets, java.util.Map<java.lang.String,Allocation> allocations, java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)	Deprecated. this constructor creates copies of all input collections
ProctorResult(java.lang.String matrixVersion, java.util.Map<java.lang.String,TestBucket> buckets, java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)	Deprecated. this constructor creates copies of all inputs
ProctorResult(java.lang.String matrixVersion, java.util.SortedMap<java.lang.String,TestBucket> buckets, java.util.SortedMap<java.lang.String,Allocation> allocations, java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)	Deprecated.
ProctorResult(java.lang.String matrixVersion, java.util.SortedMap<java.lang.String,TestBucket> buckets, java.util.SortedMap<java.lang.String,Allocation> allocations, java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions, Identifiers identifiers, java.util.Map<java.lang.String,java.lang.Object> inputContext)	Plain constructor, not creating TreeMaps.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Allocation>	getAllocations()
java.util.Map<java.lang.String,TestBucket>	getBuckets()
Identifiers	getIdentifiers()
java.util.Map<java.lang.String,java.lang.Object>	getInputContext()
java.lang.String	getMatrixVersion()
java.util.Map<java.lang.String,ConsumableTestDefinition>	getTestDefinitions()
boolean	markTestAsLogged(java.lang.String test)
static ProctorResult	unmodifiableView(ProctorResult proctorResult)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ProctorResult EMPTY

Constructor Detail

ProctorResult

@Deprecated
public ProctorResult(@Nonnull
                     int matrixVersion,
                     @Nonnull
                     java.util.Map<java.lang.String,TestBucket> buckets,
                     @Nullable
                     java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)

Deprecated.

this constructor creates copies of all inputs

Create a ProctorResult with copies of the provided collections

ProctorResult

@Deprecated
public ProctorResult(@Nonnull
                     java.lang.String matrixVersion,
                     @Nonnull
                     java.util.Map<java.lang.String,TestBucket> buckets,
                     @Nullable
                     java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)

Deprecated.

this constructor creates copies of all inputs

Create a ProctorResult with copies of the provided collections

ProctorResult

@Deprecated
public ProctorResult(java.lang.String matrixVersion,
                     @Nonnull
                     java.util.Map<java.lang.String,TestBucket> buckets,
                     @Nonnull
                     java.util.Map<java.lang.String,Allocation> allocations,
                     @Nullable
                     java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)

Deprecated.

this constructor creates copies of all input collections

Create a ProctorResult with copies of the provided collections

Parameters:

matrixVersion - any string, used for debugging

buckets - the resolved bucket for each test

allocations - the determined allocation for each test

testDefinitions - the original test definitions

ProctorResult

@Deprecated
public ProctorResult(@Nonnull
                     java.lang.String matrixVersion,
                     @Nonnull
                     java.util.SortedMap<java.lang.String,TestBucket> buckets,
                     @Nonnull
                     java.util.SortedMap<java.lang.String,Allocation> allocations,
                     @Nonnull
                     java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions)

Deprecated.

Plain constructor, not creating TreeMaps.

Parameters:

matrixVersion - any string, used for debugging

buckets - the resolved bucket for each test

allocations - the determined allocation for each test

testDefinitions - the original test definitions

ProctorResult

public ProctorResult(@Nonnull
                     java.lang.String matrixVersion,
                     @Nonnull
                     java.util.SortedMap<java.lang.String,TestBucket> buckets,
                     @Nonnull
                     java.util.SortedMap<java.lang.String,Allocation> allocations,
                     @Nonnull
                     java.util.Map<java.lang.String,ConsumableTestDefinition> testDefinitions,
                     @Nonnull
                     Identifiers identifiers,
                     @Nonnull
                     java.util.Map<java.lang.String,java.lang.Object> inputContext)

Plain constructor, not creating TreeMaps.

Parameters:

matrixVersion - any string, used for debugging

buckets - the resolved bucket for each test

allocations - the determined allocation for each test

testDefinitions - the original test definitions

Method Detail

unmodifiableView

public static ProctorResult unmodifiableView(ProctorResult proctorResult)

Returns:

a new Proctor Result, which does not allow modifying the contained collections. The result's fields are views of the original fields, to reduce memory allocation effort.

getMatrixVersion

public java.lang.String getMatrixVersion()

getBuckets

@Nonnull
public java.util.Map<java.lang.String,TestBucket> getBuckets()

Returns:

a SortedMap (should be ordered by testname)

getAllocations

@Nonnull
public java.util.Map<java.lang.String,Allocation> getAllocations()

Returns:

a SortedMap (should be ordered by testname)

getTestDefinitions

@Nonnull
public java.util.Map<java.lang.String,ConsumableTestDefinition> getTestDefinitions()

getIdentifiers

@Nonnull
public Identifiers getIdentifiers()

getInputContext

@Nonnull
public java.util.Map<java.lang.String,java.lang.Object> getInputContext()

markTestAsLogged

public boolean markTestAsLogged(java.lang.String test)