com.google.template.soy.jbcsrc.restricted

Interface SoyJbcSrcPrintDirective.Streamable

All Superinterfaces:

SoyJbcSrcPrintDirective, SoyPrintDirective

All Known Implementing Classes:

EscapeHtmlDirective, IdDirective, NoAutoescapeDirective

Enclosing interface:

SoyJbcSrcPrintDirective

public static interface SoyJbcSrcPrintDirective.Streamable
extends SoyJbcSrcPrintDirective

A print directive that supports streaming.

Streaming print directives work by wrapping the LoggingAdvisingAppendable object. This means that the value is not passed directly to the directive, instead the value is represented by a sequence of append operations on the wrapped appendable object. It is further more expected that all non-append operations (e.g. LoggingAdvisingAppendable.enterLoggableElement(com.google.template.soy.data.LogStatement)) are simply proxied through to the underlying object.

NOTE: any streamable print directive must also support a non-streaming option. The compiler will prefer to use the streaming option but it will not always be possible or necessary (for example, if the content is a compile time constant then we may avoid streaming it, or if this print directive is combined with non-streamable print directives then we will not be able to stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions A simple object that represents an Expression for a LoggingAdvisingAppendable which will apply a given print directive, as well as additional options for the behavior of the print directive.

Nested classes/interfaces inherited from interface com.google.template.soy.jbcsrc.restricted.SoyJbcSrcPrintDirective

SoyJbcSrcPrintDirective.Streamable

Method Summary

Modifier and Type	Method and Description
SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions	applyForJbcSrcStreaming(JbcSrcPluginContext context, Expression delegateAppendable, List<SoyExpression> args) Applies the directive to a LoggingAdvisingAppendable object.

Methods inherited from interface com.google.template.soy.jbcsrc.restricted.SoyJbcSrcPrintDirective

applyForJbcSrc

Methods inherited from interface com.google.template.soy.shared.restricted.SoyPrintDirective

getName, getValidArgsSizes, shouldCancelAutoescape

Method Detail

applyForJbcSrcStreaming

SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions applyForJbcSrcStreaming(JbcSrcPluginContext context,
                                                                                Expression delegateAppendable,
                                                                                List<SoyExpression> args)

Applies the directive to a LoggingAdvisingAppendable object.

Parameters:

context - The rendering context object.

delegateAppendable - The delegate appendable

args - The print directive arguments.

Returns:

An SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions for the directive.