com.atlassian.webresource.api.assembler

Interface RequiredData

@ExperimentalApi
public interface RequiredData

Interface for clients to require data blobs.

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
RequiredData	requireData(String key, Boolean content) Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
RequiredData	requireData(String key, Boolean content, ResourcePhase resourcePhase)
RequiredData	requireData(String key, CompletionStage<com.atlassian.json.marshal.Jsonable> promise) Specifies that JSON data with the given key should be avaialbe to the client-side webpage at some point in the future.
RequiredData	requireData(String key, com.atlassian.json.marshal.Jsonable content) Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
RequiredData	requireData(String key, com.atlassian.json.marshal.Jsonable content, ResourcePhase resourcePhase)
RequiredData	requireData(String key, Number content) Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
RequiredData	requireData(String key, Number content, ResourcePhase resourcePhase)
RequiredData	requireData(String key, String content) Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
RequiredData	requireData(String key, String content, ResourcePhase resourcePhase)

Method Detail

requireData

RequiredData requireData(String key,
                         com.atlassian.json.marshal.Jsonable content)

Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().

Parameters:

key - data key

content - JSON data

Returns:

this, to support method chaining WRM.data() JavaScript API

requireData

RequiredData requireData(String key,
                         com.atlassian.json.marshal.Jsonable content,
                         ResourcePhase resourcePhase)

requireData

RequiredData requireData(String key,
                         Number content)

Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().

Parameters:

key - data key

content - content to render

Returns:

this, to support method chaining WRM.data() JavaScript API

requireData

RequiredData requireData(String key,
                         Number content,
                         ResourcePhase resourcePhase)

requireData

RequiredData requireData(String key,
                         String content)

Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().

Parameters:

key - data key

content - content to render

Returns:

this, to support method chaining WRM.data() JavaScript API

requireData

RequiredData requireData(String key,
                         String content,
                         ResourcePhase resourcePhase)

requireData

RequiredData requireData(String key,
                         Boolean content)

Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().

Parameters:

key - data key

content - content to render

Returns:

this, to support method chaining WRM.data() JavaScript API

requireData

RequiredData requireData(String key,
                         Boolean content,
                         ResourcePhase resourcePhase)

requireData

RequiredData requireData(String key,
                         CompletionStage<com.atlassian.json.marshal.Jsonable> promise)

Specifies that JSON data with the given key should be avaialbe to the client-side webpage at some point in the future. This may be at a subsequent call to drainIncludedResources() or pollIncludedResources().

A CompletionStage may complete normally or exceptionally. Both situations will be communicated to the client-side.

The Web Resource mechanism will not keep track of the promise for an indefinite period of time, see WebResourceAssemblerBuilder.asyncDataDeadline(long, TimeUnit). A promise that is not complete by the deadline will be returned to client-side as if it had completed exceptionally.

Parameters:

key - data key

promise - promise content to render WRM.data() JavaScript API