Package com.linecorp.armeria.common

Class AggregationOptionsBuilder

java.lang.Object

com.linecorp.armeria.common.AggregationOptionsBuilder

@UnstableApi
public final class AggregationOptionsBuilder
extends Object

A builder for AggregationOptions.

Method Summary

Modifier and Type	Method	Description
AggregationOptionsBuilder	alloc(ByteBufAllocator alloc)	(Advanced users only) Sets the ByteBufAllocator that can be used to create a PooledObjects without making a copy.
AggregationOptions	build()	Returns a newly created AggregationOptions with the properties set so far.
AggregationOptionsBuilder	cacheResult(boolean cache)	Returns whether to cache the aggregation result.
AggregationOptionsBuilder	executor(EventExecutor executor)	Sets the EventExecutor to run the aggregation function on.

Methods inherited from class java.lang.Object

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

Method Details

executor

public AggregationOptionsBuilder executor(EventExecutor executor)

Sets the EventExecutor to run the aggregation function on.

cacheResult

public AggregationOptionsBuilder cacheResult(boolean cache)

Returns whether to cache the aggregation result. This option is disabled by default. Note that this method and alloc(ByteBufAllocator) are mutually exclusive. If alloc(ByteBufAllocator)} is set and this option is enabled, an IllegalStateException will be raised.

alloc

public AggregationOptionsBuilder alloc(ByteBufAllocator alloc)

(Advanced users only) Sets the ByteBufAllocator that can be used to create a PooledObjects without making a copy. If unspecified, a byte[]-based HttpData is created.

PooledObjects cannot be cached since they have their own life cycle. Therefore, that this method and cacheResult(boolean) are mutually exclusive. If cacheResult(boolean) is enabled and this option is set, an IllegalStateException will be raised.

build

public AggregationOptions build()

Returns a newly created AggregationOptions with the properties set so far.