com.google.template.soy.shared.restricted

Class StreamingEscaper

java.lang.Object

com.google.template.soy.data.LoggingAdvisingAppendable

com.google.template.soy.shared.restricted.StreamingEscaper

All Implemented Interfaces:

AdvisingAppendable, Appendable

public final class StreamingEscaper
extends LoggingAdvisingAppendable

A StreamingEscaper is a decorator for a LoggingAdvisingAppendable that applies escaping logic to untrusted content.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.data.LoggingAdvisingAppendable

LoggingAdvisingAppendable.BufferingAppendable

Method Summary

Modifier and Type	Method and Description
LoggingAdvisingAppendable	append(char c)
LoggingAdvisingAppendable	append(CharSequence csq)
LoggingAdvisingAppendable	append(CharSequence csq, int start, int end)
LoggingAdvisingAppendable	appendLoggingFunctionInvocation(LoggingFunctionInvocation funCall, com.google.common.collect.ImmutableList<com.google.common.base.Function<String,String>> escapers) Called whenever a logging function is being rendered.
static StreamingEscaper	create(LoggingAdvisingAppendable delegate, EscapingConventions.CrossLanguageStringXform transform) Creates a streaming escaper, or returns the delegate if it is already escaping with the same settings.
LoggingAdvisingAppendable	enterLoggableElement(LogStatement statement) Called whenever a loggable element is entered.
LoggingAdvisingAppendable	exitLoggableElement() Called whenever a loggable element is exited.
boolean	softLimitReached() Indicates that an internal limit has been reached or exceeded and that write operations should be suspended soon.

Methods inherited from class com.google.template.soy.data.LoggingAdvisingAppendable

buffering, delegating, escapePlaceholder, getSanitizedContentDirectionality, getSantizedContentKind, notifyContentDirectionality, notifyContentKind, setSanitizedContentDirectionality, setSanitizedContentKind, stringCoercing

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StreamingEscaper create(LoggingAdvisingAppendable delegate,
                                      EscapingConventions.CrossLanguageStringXform transform)

Creates a streaming escaper, or returns the delegate if it is already escaping with the same settings.

append

public final LoggingAdvisingAppendable append(CharSequence csq)
                                       throws IOException

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Specified by:

append in class LoggingAdvisingAppendable

Throws:

IOException

append

public final LoggingAdvisingAppendable append(CharSequence csq,
                                              int start,
                                              int end)
                                       throws IOException

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Specified by:

append in class LoggingAdvisingAppendable

Throws:

IOException

append

public final LoggingAdvisingAppendable append(char c)
                                       throws IOException

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Specified by:

append in class LoggingAdvisingAppendable

Throws:

IOException

appendLoggingFunctionInvocation

public LoggingAdvisingAppendable appendLoggingFunctionInvocation(LoggingFunctionInvocation funCall,
                                                                 com.google.common.collect.ImmutableList<com.google.common.base.Function<String,String>> escapers)
                                                          throws IOException

Description copied from class: LoggingAdvisingAppendable

Called whenever a logging function is being rendered.

TODO(lukes): come up with a better interface than Function. Maybe Escaper?

Specified by:

appendLoggingFunctionInvocation in class LoggingAdvisingAppendable

Parameters:

funCall - The function invocation

escapers - The escapers to apply to the result. NOTE: this should be SoyJavaPrintDirective or similar but that would cause cycles between soy.data and soy.shared.restricted

Returns:

this

Throws:

IOException

softLimitReached

public final boolean softLimitReached()

Description copied from interface: AdvisingAppendable

Indicates that an internal limit has been reached or exceeded and that write operations should be suspended soon.

enterLoggableElement

public LoggingAdvisingAppendable enterLoggableElement(LogStatement statement)

Description copied from class: LoggingAdvisingAppendable

Called whenever a loggable element is entered.

Specified by:

enterLoggableElement in class LoggingAdvisingAppendable

exitLoggableElement

public LoggingAdvisingAppendable exitLoggableElement()

Description copied from class: LoggingAdvisingAppendable

Called whenever a loggable element is exited.

Specified by:

exitLoggableElement in class LoggingAdvisingAppendable