com.google.template.soy.tofu.restricted

Interface SoyTofuPrintDirective

All Superinterfaces:

SoyPrintDirective

All Known Implementing Classes:

SoyAbstractTofuPrintDirective

public interface SoyTofuPrintDirective
extends SoyPrintDirective

Interface for a Soy print directive implemented for the Tofu backend (a.k.a. Java Object backend).

Important: This may only be used in implementing print directive plugins.

Consider also implementing SoyJavaRuntimePrintDirective. The apply() method in SoyJavaRuntimePrintDirective should be exactly the same as the applyForTofu() method of this interface, but can be used outside of the Tofu backend by optimization passes. The easiest way to implement both interfaces at once is to subclass SoyAbstractTofuPrintDirective.

See Also:

SoyAbstractTofuPrintDirective, SoyJavaRuntimePrintDirective

Method Summary

Modifier and Type	Method and Description
SoyData	applyForTofu(SoyData value, List<SoyData> args) Applies this directive on the given value.

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

getName, getValidArgsSizes, shouldCancelAutoescape

Method Detail

applyForTofu

SoyData applyForTofu(SoyData value,
                     List<SoyData> args)

Applies this directive on the given value.

Parameters:

value - The input to the directive. This may have not yet been coerced to a string.

args - The directive's arguments, if any (usually none).

Returns:

The resulting value.