com.google.template.soy.data

Class LoggingAdvisingAppendable

java.lang.Object

com.google.template.soy.data.LoggingAdvisingAppendable

All Implemented Interfaces:

AdvisingAppendable, Appendable

Direct Known Subclasses:

AbstractLoggingAdvisingAppendable, AbstractStreamingHtmlEscaper, ForwardingLoggingAdvisingAppendable, StreamingEscaper

public abstract class LoggingAdvisingAppendable
extends Object
implements AdvisingAppendable

An AdvisingAppendable that can also process log statements.

NOTE: all the logging functionality is currently stubbed out.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingAdvisingAppendable.BufferingAppendable A LoggingAdvisingAppendable that renders to a string builder.

Constructor Summary

Constructors

Constructor and Description
LoggingAdvisingAppendable()

Method Summary

Modifier and Type	Method and Description
abstract LoggingAdvisingAppendable	append(char c)
abstract LoggingAdvisingAppendable	append(CharSequence csq)
abstract LoggingAdvisingAppendable	append(CharSequence csq, int start, int end)
abstract 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 LoggingAdvisingAppendable.BufferingAppendable	buffering() Returns a LoggingAdvisingAppendable.BufferingAppendable that renders everything to a buffer that can be accessed via LoggingAdvisingAppendable.BufferingAppendable.toString() or LoggingAdvisingAppendable.BufferingAppendable.getAndClearBuffer()
static LoggingAdvisingAppendable	delegating(Appendable appendable) Returns a LoggingAdvisingAppendable that delegates to an Appendable
abstract LoggingAdvisingAppendable	enterLoggableElement(LogStatement statement) Called whenever a loggable element is entered.
protected static String	escapePlaceholder(String placeholder, List<com.google.common.base.Function<String,String>> escapers)
abstract LoggingAdvisingAppendable	exitLoggableElement() Called whenever a loggable element is exited.
Dir	getSanitizedContentDirectionality() Returns the directionality of this appendable.
SanitizedContent.ContentKind	getSantizedContentKind() Returns the content kind of this appendable.
protected void	notifyContentDirectionality(Dir contentDir) Called when the directionality is initially set.
protected void	notifyContentKind(SanitizedContent.ContentKind kind) Called when the content kind is initially set.
LoggingAdvisingAppendable	setSanitizedContentDirectionality(Dir contentDir) Marks the directionality of this appendable.
LoggingAdvisingAppendable	setSanitizedContentKind(SanitizedContent.ContentKind kind) Marks the content kind of this appendable.
static LoggingAdvisingAppendable	stringCoercing(LoggingAdvisingAppendable delegate) An implementation that only delegates append(java.lang.CharSequence) calls.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.template.soy.jbcsrc.api.AdvisingAppendable

softLimitReached

Constructor Detail

LoggingAdvisingAppendable

public LoggingAdvisingAppendable()

Method Detail

buffering

public static LoggingAdvisingAppendable.BufferingAppendable buffering()

Returns a LoggingAdvisingAppendable.BufferingAppendable that renders everything to a buffer that can be accessed via LoggingAdvisingAppendable.BufferingAppendable.toString() or LoggingAdvisingAppendable.BufferingAppendable.getAndClearBuffer()

delegating

public static LoggingAdvisingAppendable delegating(Appendable appendable)

Returns a LoggingAdvisingAppendable that delegates to an Appendable

stringCoercing

public static LoggingAdvisingAppendable stringCoercing(LoggingAdvisingAppendable delegate)

An implementation that only delegates append(java.lang.CharSequence) calls. This has the effect of coercing the content to a string by dropping all the strict content directives.

append

public abstract LoggingAdvisingAppendable append(CharSequence csq)
                                          throws IOException

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Throws:

IOException

append

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

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Throws:

IOException

append

public abstract LoggingAdvisingAppendable append(char c)
                                          throws IOException

Specified by:

append in interface AdvisingAppendable

Specified by:

append in interface Appendable

Throws:

IOException

enterLoggableElement

public abstract LoggingAdvisingAppendable enterLoggableElement(LogStatement statement)

Called whenever a loggable element is entered.

exitLoggableElement

public abstract LoggingAdvisingAppendable exitLoggableElement()

Called whenever a loggable element is exited.

setSanitizedContentKind

public final LoggingAdvisingAppendable setSanitizedContentKind(SanitizedContent.ContentKind kind)
                                                        throws IOException

Marks the content kind of this appendable. All the append(java.lang.CharSequence) commands should be considered to be content of the given kind that has already been sanitized.

Calls after the first call to this are ignored. In the case of an appendable's content kind changing, we trust that the autoescaper has inserted the correct escape directives, so we do not need to track this in the appendable.

Throws:

IOException

notifyContentKind

protected void notifyContentKind(SanitizedContent.ContentKind kind)
                          throws IOException

Called when the content kind is initially set. Override this be notified when the content kind is set.

Throws:

IOException

See Also:

#setSanitizedContentKind(ContentKind)

getSantizedContentKind

@Nullable
public final SanitizedContent.ContentKind getSantizedContentKind()

Returns the content kind of this appendable.

See Also:

#setSanitizedContentKind(ContentKind)

setSanitizedContentDirectionality

public final LoggingAdvisingAppendable setSanitizedContentDirectionality(@Nullable
                                                                         Dir contentDir)
                                                                  throws IOException

Marks the directionality of this appendable. All the append(java.lang.CharSequence) commands should be considered to be content of the given directionality that has already been sanitized.

Calls after the first call to this are ignored.

Throws:

IOException

notifyContentDirectionality

protected void notifyContentDirectionality(Dir contentDir)
                                    throws IOException

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

Throws:

IOException

See Also:

setSanitizedContentDirectionality(Dir)

getSanitizedContentDirectionality

@Nullable
public final Dir getSanitizedContentDirectionality()

Returns the directionality of this appendable.

See Also:

setSanitizedContentDirectionality(Dir)

appendLoggingFunctionInvocation

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

Called whenever a logging function is being rendered.

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

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

escapePlaceholder

protected static String escapePlaceholder(String placeholder,
                                          List<com.google.common.base.Function<String,String>> escapers)