org.esigate.parser.future

Class StringBuilderFutureAppendable

java.lang.Object

org.esigate.parser.future.StringBuilderFutureAppendable

All Implemented Interfaces:

Future<CharSequence>, FutureAppendable

public class StringBuilderFutureAppendable
extends Object
implements FutureAppendable, Future<CharSequence>

This is an implementation of StringBuilder which can append Future<CharSequence> and is a Future<CharSequence> itself.

It is intended for temporary buffers when implementing nested tags.

Author:

Nicolas Richeton

Constructor Summary

Constructors

Constructor and Description
StringBuilderFutureAppendable() Create a new builder with a default capacity of 1024.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
FutureAppendable	enqueueAppend(Future<CharSequence> csq) Queue the Future<CharSequence> for append in this FutureAppendable.
CharSequence	get()
CharSequence	get(long timeout, TimeUnit unit)
boolean	hasPending() Check if some append operations are still waiting for FutureAppendable.performAppends() to be called.
boolean	isCancelled()
boolean	isDone()
FutureAppendable	performAppends() Wait for all computation to complete and perform the pending append operations.
FutureAppendable	performAppends(int timeout, TimeUnit unit) Wait for all computation to complete and perform the pending append operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringBuilderFutureAppendable

public StringBuilderFutureAppendable()

Create a new builder with a default capacity of 1024.

Method Detail

enqueueAppend

public FutureAppendable enqueueAppend(Future<CharSequence> csq)

Description copied from interface: FutureAppendable

Queue the Future<CharSequence> for append in this FutureAppendable.

Caller may start computing the content of the Future parameter before or after calling this method (using other Thread) or simply wait for Future#get() to be called (deferred computation).

Specified by:

enqueueAppend in interface FutureAppendable

Parameters:

csq - The Future character sequence to append. If csq is null, then the four characters "null" are appended to this FutureAppendable.

Returns:

A reference to this FutureAppendable

performAppends

public FutureAppendable performAppends()
                                throws IOException,
                                       HttpErrorPage

Description copied from interface: FutureAppendable

Wait for all computation to complete and perform the pending append operations.

Specified by:

performAppends in interface FutureAppendable

Returns:

A reference to this FutureAppendable

Throws:

IOException

HttpErrorPage

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<CharSequence>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<CharSequence>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<CharSequence>

get

public CharSequence get()
                 throws ExecutionException

Specified by:

get in interface Future<CharSequence>

Throws:

ExecutionException

get

public CharSequence get(long timeout,
                        TimeUnit unit)
                 throws ExecutionException

Specified by:

get in interface Future<CharSequence>

Throws:

ExecutionException

hasPending

public boolean hasPending()

Description copied from interface: FutureAppendable

Check if some append operations are still waiting for FutureAppendable.performAppends() to be called.

Specified by:

hasPending in interface FutureAppendable

Returns:

true if append operations are pending.

performAppends

public FutureAppendable performAppends(int timeout,
                                       TimeUnit unit)
                                throws IOException,
                                       HttpErrorPage,
                                       TimeoutException

Description copied from interface: FutureAppendable

Wait for all computation to complete and perform the pending append operations.

Specified by:

performAppends in interface FutureAppendable

Returns:

FutureAppendable

Throws:

IOException

HttpErrorPage

TimeoutException