com.google.template.soy.jbcsrc.runtime

Class JbcSrcRuntime

java.lang.Object

com.google.template.soy.jbcsrc.runtime.JbcSrcRuntime

public final class JbcSrcRuntime
extends Object

Runtime utilities uniquely for the jbcsrc backend.

This class is public so it can be be used by generated template code. Please do not use it from client code.

Field Summary

Fields

Modifier and Type	Field and Description
static SoyValueProvider	NULL_PROVIDER

Constructor Summary

Constructors

Constructor and Description
JbcSrcRuntime()

Method Summary

Modifier and Type	Method and Description
static CompiledTemplate	applyEscapers(CompiledTemplate delegate, com.google.common.collect.ImmutableList<SoyJavaPrintDirective> directives) Wraps a given template with a collection of escapers to apply.
static SoyValue	applyPrintDirective(SoyJavaPrintDirective directive, SoyValue value, List<SoyValue> args) Helper function to translate null -> NullData when calling SoyJavaPrintDirectives that may expect it.
static SoyValue	callSoyFunction(SoyJavaFunction function, List<SoyValue> args) Helper function to translate null -> NullData when calling SoyJavaFunctions that may expect it.
static boolean	coerceToBoolean(double v)
static String	coerceToString(SoyValue v)
static boolean	compareNullableString(String string, SoyValue other) Determines if the operand's string form can be equality-compared with a string.
static SoyValueProvider	getFieldProvider(SoyRecord record, String field) Helper function to make SoyRecord.getFieldProvider a non-nullable function by returning NULL_PROVIDER for missing fields.
static RenderResult	getListStatus(List<? extends SoyValueProvider> soyValueProviders)
static RenderResult	getMapStatus(Map<String,? extends SoyValueProvider> soyValueProviders)
static SoyValueProvider	getSoyLegacyObjectMapItem(SoyLegacyObjectMap legacyObjectMap, SoyValue key)
static SoyValueProvider	getSoyListItem(List<SoyValueProvider> list, long index)
static SoyValueProvider	getSoyMapItem(SoyMap soyMap, SoyValue key)
static LoggingAdvisingAppendable	logger()
static com.google.template.soy.jbcsrc.runtime.JbcSrcRuntime.ClosePropagatingAppendable	propagateClose(LoggingAdvisingAppendable delegate, com.google.common.collect.ImmutableList<Closeable> closeables) Returns a LoggingAdvisingAppendable that: Forwards all LoggingAdvisingAppendable methods to delegate Implements Closeable and forwards all Closeable.close() calls to the given closeables in order.
static int	rangeLoopLength(int start, int end, int step)
static void	renderSoyMsgPartsWithPlaceholders(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts, com.ibm.icu.util.ULocale locale, Map<String,Object> placeholders, Appendable out) Render a 'complex' message containing with placeholders.
static SoyValue	resolveSoyValueProvider(SoyValueProvider provider) Helper function to translate NullData -> null when resolving a SoyValueProvider.
static boolean	stringEqualsAsNumber(String expr, double number)
static AssertionError	unexpectedStateError(int state)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_PROVIDER

public static final SoyValueProvider NULL_PROVIDER

Constructor Detail

JbcSrcRuntime

public JbcSrcRuntime()

Method Detail

unexpectedStateError

public static AssertionError unexpectedStateError(int state)

stringEqualsAsNumber

public static boolean stringEqualsAsNumber(String expr,
                                           double number)

resolveSoyValueProvider

public static SoyValue resolveSoyValueProvider(SoyValueProvider provider)

Helper function to translate NullData -> null when resolving a SoyValueProvider.

getFieldProvider

public static SoyValueProvider getFieldProvider(SoyRecord record,
                                                String field)

Helper function to make SoyRecord.getFieldProvider a non-nullable function by returning NULL_PROVIDER for missing fields.

callSoyFunction

public static SoyValue callSoyFunction(SoyJavaFunction function,
                                       List<SoyValue> args)

Helper function to translate null -> NullData when calling SoyJavaFunctions that may expect it.

In the long run we should either fix ToFu (and all SoyJavaFunctions) to not use NullData or we should introduce custom SoyFunction implementations for have come from SoyValueProvider.

applyPrintDirective

public static SoyValue applyPrintDirective(SoyJavaPrintDirective directive,
                                           SoyValue value,
                                           List<SoyValue> args)

Helper function to translate null -> NullData when calling SoyJavaPrintDirectives that may expect it.

applyEscapers

public static CompiledTemplate applyEscapers(CompiledTemplate delegate,
                                             com.google.common.collect.ImmutableList<SoyJavaPrintDirective> directives)

Wraps a given template with a collection of escapers to apply.

Parameters:

delegate - The delegate template to render

directives - The set of directives to apply

getSoyListItem

public static SoyValueProvider getSoyListItem(List<SoyValueProvider> list,
                                              long index)

getListStatus

public static RenderResult getListStatus(List<? extends SoyValueProvider> soyValueProviders)

getMapStatus

public static RenderResult getMapStatus(Map<String,? extends SoyValueProvider> soyValueProviders)

getSoyMapItem

public static SoyValueProvider getSoyMapItem(SoyMap soyMap,
                                             SoyValue key)

getSoyLegacyObjectMapItem

public static SoyValueProvider getSoyLegacyObjectMapItem(SoyLegacyObjectMap legacyObjectMap,
                                                         SoyValue key)

renderSoyMsgPartsWithPlaceholders

public static void renderSoyMsgPartsWithPlaceholders(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts,
                                                     @Nullable
                                                     com.ibm.icu.util.ULocale locale,
                                                     Map<String,Object> placeholders,
                                                     Appendable out)
                                              throws IOException

Render a 'complex' message containing with placeholders.

Throws:

IOException

compareNullableString

public static boolean compareNullableString(@Nullable
                                            String string,
                                            SoyValue other)

Determines if the operand's string form can be equality-compared with a string.

logger

public static LoggingAdvisingAppendable logger()

rangeLoopLength

public static int rangeLoopLength(int start,
                                  int end,
                                  int step)

coerceToBoolean

public static boolean coerceToBoolean(double v)

coerceToString

public static String coerceToString(@Nullable
                                    SoyValue v)

propagateClose

public static com.google.template.soy.jbcsrc.runtime.JbcSrcRuntime.ClosePropagatingAppendable propagateClose(LoggingAdvisingAppendable delegate,
                                                                                                             com.google.common.collect.ImmutableList<Closeable> closeables)

Returns a LoggingAdvisingAppendable that:

• Forwards all LoggingAdvisingAppendable methods to delegate
• Implements Closeable and forwards all Closeable.close() calls to the given closeables in order.

This strategy allows us to make certain directives closeable without requiring them all to be since this wrapper can propagate the close signals in the rare case that a closeable directive is wrapped with a non closeable one (or multiple closeable wrappers are composed)