com.google.template.soy.jbcsrc.runtime

Class DetachableContentProvider

java.lang.Object

com.google.template.soy.jbcsrc.runtime.DetachableContentProvider

All Implemented Interfaces:

SoyValueProvider

public abstract class DetachableContentProvider
extends Object
implements SoyValueProvider

A special implementation of SoyValueProvider to use as a shared base class for the jbcsrc implementations of the generated LetContentNode and CallParamContentNode implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachableContentProvider(SanitizedContent.ContentKind contentKind)

Method Summary

Modifier and Type	Method and Description
protected abstract RenderResult	doRender(LoggingAdvisingAppendable appendable) Overridden by generated subclasses to implement lazy detachable resolution.
RenderResult	renderAndResolve(LoggingAdvisingAppendable appendable, boolean isLast) Renders this value to the given LoggingAdvisingAppendable, possibly partially.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.
RenderResult	status() Returns RenderResult.done() if the value provider can be resolved without blocking on a future.

Methods inherited from class java.lang.Object

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

Constructor Detail

DetachableContentProvider

protected DetachableContentProvider(@Nullable
                                    SanitizedContent.ContentKind contentKind)

Method Detail

resolve

public final SoyValue resolve()

Description copied from interface: SoyValueProvider

Usually, this method is a no-op that simply returns this object. However, if this value needs to be resolved at usage time, then this method resolves and returns the resolved value.

Specified by:

resolve in interface SoyValueProvider

Returns:

The resolved value.

status

public final RenderResult status()

Description copied from interface: SoyValueProvider

Returns RenderResult.done() if the value provider can be resolved without blocking on a future. Otherwise, returns a RenderResult that holds the future.

Note, once this method returns RenderResult.done() all future calls must also return RenderResult.done().

This method will never return a limited RenderResult

Specified by:

status in interface SoyValueProvider

renderAndResolve

public RenderResult renderAndResolve(LoggingAdvisingAppendable appendable,
                                     boolean isLast)
                              throws IOException

Description copied from interface: SoyValueProvider

Renders this value to the given LoggingAdvisingAppendable, possibly partially.

This should render the exact same content as resolve().render(Appendable) but may optionally detach part of the way through rendering. Note, this means that this method is stateful and if it returns something besides RenderResult.done() then the next call to this method will resume rendering from the previous point.

Specified by:

renderAndResolve in interface SoyValueProvider

Parameters:

appendable - The appendable to render to.

isLast - True if this is definitely the last time this value will be rendered. Used as a hint to implementations to not optimize for later calls (for example, by storing render results in a buffer for faster re-renders). The value of this parameter should not affect behavior of this method, only performance.

Returns:

A RenderResult that describes whether or not rendering completed. If the returned result is not done, then to complete rendering you must call this method again.

Throws:

IOException - If the appendable throws an IOException

doRender

protected abstract RenderResult doRender(LoggingAdvisingAppendable appendable)

Overridden by generated subclasses to implement lazy detachable resolution.