org.apache.reef.vortex.api

Class VortexAggregatePolicy.AggregatePolicyBuilder

java.lang.Object

org.apache.reef.vortex.api.VortexAggregatePolicy.AggregatePolicyBuilder

All Implemented Interfaces:

Builder<VortexAggregatePolicy>

Enclosing class:

VortexAggregatePolicy

public static final class VortexAggregatePolicy.AggregatePolicyBuilder
extends Object
implements Builder<VortexAggregatePolicy>

A Builder class for VortexAggregatePolicy.

Method Summary

Methods

Modifier and Type	Method and Description
VortexAggregatePolicy	build() Builds and returns a new VortexAggregatePolicy based on user's specification.
VortexAggregatePolicy.AggregatePolicyBuilder	setCountTrigger(int pCount) Sets the count trigger for aggregation.
VortexAggregatePolicy.AggregatePolicyBuilder	setTimerPeriodTrigger(int pOffsetMilliseconds) Sets the period to trigger aggregation in milliseconds.

Methods inherited from class java.lang.Object

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

Method Detail

setTimerPeriodTrigger

public VortexAggregatePolicy.AggregatePolicyBuilder setTimerPeriodTrigger(int pOffsetMilliseconds)

Sets the period to trigger aggregation in milliseconds. Required parameter to build.

setCountTrigger

public VortexAggregatePolicy.AggregatePolicyBuilder setCountTrigger(int pCount)

Sets the count trigger for aggregation. Not required.

build

public VortexAggregatePolicy build()
                            throws IllegalArgumentException

Builds and returns a new VortexAggregatePolicy based on user's specification. The timer period is a required parameter for this to succeed.

Specified by:

build in interface Builder<VortexAggregatePolicy>

Returns:

a fresh instance of the object.

Throws:

IllegalArgumentException - if required parameters are not set or if parameters are invalid.