com.atlassian.plugin.webresource.bigpipe

Class BigPipe

java.lang.Object

com.atlassian.plugin.webresource.bigpipe.BigPipe

public final class BigPipe
extends Object

Constructor Summary

Constructors

Constructor and Description
BigPipe()

Method Summary

Modifier and Type	Method and Description
Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>>	forceCompleteAll()
Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>>	getAvailableContent()
boolean	isComplete()
BigPipe	push(String key, CompletionStage<com.atlassian.json.marshal.Jsonable> promise)
Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>>	waitForContent() Waits for content.
Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>>	waitForContent(long timeout, TimeUnit unit) Waits for content.

Methods inherited from class java.lang.Object

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

Constructor Detail

BigPipe

public BigPipe()

Method Detail

push

public BigPipe push(String key,
                    CompletionStage<com.atlassian.json.marshal.Jsonable> promise)

getAvailableContent

public Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>> getAvailableContent()

Returns:

all available content without blocking. If no content is available, the empty list is returned.

forceCompleteAll

public Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>> forceCompleteAll()

Returns:

return all content without blocking. Any incomplete futures are converted to failures

waitForContent

@ExperimentalApi
public Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>> waitForContent()
                                                                                                 throws InterruptedException

Waits for content.

If any content is available, this method returns immediately. If content is not available, it blocks until any content becomes available. Warning: This function doesn't contain any timeout - may be dangerous to those who create 'promises without future'. Always make sure that your promises are being executed when using this function. Experimental: Currently function only waits if there are any pending tasks, it may change in the future.

Returns:

content from the Big Pipe.

Throws:

InterruptedException - if interrupted while executing

waitForContent

public Iterable<KeyedValue<String,com.atlassian.json.marshal.Jsonable>> waitForContent(long timeout,
                                                                                       TimeUnit unit)
                                                                                throws InterruptedException

Waits for content.

If any content is available, this method returns immediately. If content is not available, it blocks until any content becomes available.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

content from the Big Pipe. If no content becomes available before the timeout, the empty list is returned.

Throws:

InterruptedException - if interrupted while executing

isComplete

public boolean isComplete()