com.google.template.soy.shared.internal

Class AbstractStreamingHtmlEscaper

java.lang.Object

com.google.template.soy.data.LoggingAdvisingAppendable

com.google.template.soy.shared.internal.AbstractStreamingHtmlEscaper

All Implemented Interfaces:

AdvisingAppendable, Appendable

public abstract class AbstractStreamingHtmlEscaper
extends LoggingAdvisingAppendable

A delegating LoggingAdvisingAppendable that can detect when the appendable is in an html context or not.

This tracks the activeAppendable, or the appendable append calls should be sent to, based on the content kind. The active appendable starts out as the appendable that does the escaping (the escapingAppendable constructor param). Subclasses can overwrite the activeAppendable field in the #notifyContentKind(ContentKind) method based on the content kind.

Nested Class Summary

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

LoggingAdvisingAppendable.BufferingAppendable

Field Summary

Fields

Modifier and Type	Field and Description
protected Appendable	activeAppendable
protected LoggingAdvisingAppendable	delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStreamingHtmlEscaper(LoggingAdvisingAppendable delegate, Appendable escapingAppendable)

Method Summary

Modifier and Type	Method and Description
LoggingAdvisingAppendable	append(char c)
LoggingAdvisingAppendable	append(CharSequence csq)
LoggingAdvisingAppendable	append(CharSequence csq, int start, int end)
protected boolean	isInHtml()
protected void	notifyContentDirectionality(Dir contentDir) Called when the directionality is initially set.
protected abstract void	notifyContentKind(SanitizedContent.ContentKind kind) Override this to set the appendable for the append methods to delegate to, based on the content kind.
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

appendLoggingFunctionInvocation, buffering, delegating, enterLoggableElement, escapePlaceholder, exitLoggableElement, getSanitizedContentDirectionality, getSantizedContentKind, setSanitizedContentDirectionality, setSanitizedContentKind, stringCoercing

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final LoggingAdvisingAppendable delegate

activeAppendable

protected Appendable activeAppendable

Constructor Detail

AbstractStreamingHtmlEscaper

protected AbstractStreamingHtmlEscaper(LoggingAdvisingAppendable delegate,
                                       Appendable escapingAppendable)

Method Detail

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

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.

notifyContentKind

protected abstract void notifyContentKind(SanitizedContent.ContentKind kind)
                                   throws IOException

Override this to set the appendable for the append methods to delegate to, based on the content kind.

Overrides:

notifyContentKind in class LoggingAdvisingAppendable

Throws:

IOException

See Also:

#setSanitizedContentKind(ContentKind)

notifyContentDirectionality

protected void notifyContentDirectionality(@Nullable
                                           Dir contentDir)
                                    throws IOException

Description copied from class: LoggingAdvisingAppendable

Called when the directionality is initially set. Override this be notified when the directionality is set.

Overrides:

notifyContentDirectionality in class LoggingAdvisingAppendable

Throws:

IOException

See Also:

LoggingAdvisingAppendable.setSanitizedContentDirectionality(Dir)

isInHtml

protected final boolean isInHtml()