com.google.template.soy.logging

Interface LoggingFunction

All Superinterfaces:

SoyFunction

public interface LoggingFunction
extends SoyFunction

A LoggingFunction is a SoyFunction that is meant to interact with the logging subsystem.

Unlike a SoyJsSrcFunction or a SoyJavaFunction the author of a LoggingFunction does not implement the function logic here, but instead it will be implemented by a user supplied logging plugin at render time.

Method Summary

Modifier and Type	Method and Description
String	getPlaceholder() A static placeholder that can be used in place of the real implementation in the logging plugin.

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

getName, getValidArgsSizes

Method Detail

getPlaceholder

String getPlaceholder()

A static placeholder that can be used in place of the real implementation in the logging plugin. This can happen in several cases:

• The function invocation is used in the context of a soy expression, and so the value is needed immediately.
• The function is invoked in a template block that is ultimately escaped.
• There is no configured logging plugin.