com.atlassian.webresource.api.assembler

Interface WebResourceAssemblerBuilder

@ExperimentalApi
public interface WebResourceAssemblerBuilder

Builder for constructing WebResourceAssembler

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
WebResourceAssemblerBuilder	asyncDataDeadline(long deadline, TimeUnit timeunit) Asynchronous data can be required with RequiredData.requireData(String, CompletionStage).
WebResourceAssembler	build() Constructs a WebResourceAssembler
WebResourceAssemblerBuilder	includeSuperbatchResources(boolean include) In addition to any resources explicitly added to the WebResourceAssembler, always implicitly include resources from the superbatch.

Method Detail

includeSuperbatchResources

WebResourceAssemblerBuilder includeSuperbatchResources(boolean include)

In addition to any resources explicitly added to the WebResourceAssembler, always implicitly include resources from the superbatch. When disabled, superbatch resources are not implicitly included, but may be individually (and explicitly) included by requiring them with the WebResourceAssembler.

asyncDataDeadline

WebResourceAssemblerBuilder asyncDataDeadline(long deadline,
                                              TimeUnit timeunit)

Asynchronous data can be required with RequiredData.requireData(String, CompletionStage). Such promises must complete within a deadline, otherwise they will considered as if they completed exceptionally and any value they may have returned will be discarded. The timer for the deadline starts when build() is called.

build

WebResourceAssembler build()

Constructs a WebResourceAssembler

Returns:

a WebResourceAssembler