com.google.template.soy.jssrc.internal

Class SoyToJsVariableMappings

java.lang.Object

com.google.template.soy.jssrc.internal.SoyToJsVariableMappings

public final class SoyToJsVariableMappings
extends Object

Manages the mappings between Soy variables and their JavaScript equivalents inside a single template.

Method Summary

Modifier and Type	Method and Description
static SoyToJsVariableMappings	forNewTemplate() Returns a new SoyToJsVariableMappings suitable for translating an entire template.
CodeChunk.WithValue	get(String name) Returns the JavaScript translation for the Soy variable with the given name,
CodeChunk.WithValue	maybeGet(String name) Returns the JavaScript translation for the Soy variable with the given name, or null if no mapping exists for that variable.
SoyToJsVariableMappings	put(String var, CodeChunk.WithValue translation) Maps the Soy variable named name to the given translation.

Methods inherited from class java.lang.Object

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

Method Detail

forNewTemplate

public static SoyToJsVariableMappings forNewTemplate()

Returns a new SoyToJsVariableMappings suitable for translating an entire template.

put

public SoyToJsVariableMappings put(String var,
                                   CodeChunk.WithValue translation)

Maps the Soy variable named name to the given translation. Any previous mapping for the variable is lost. TODO(brndn): this API requires callers to mangle the names they pass in to ensure uniqueness. Do the mangling internally.

get

public CodeChunk.WithValue get(String name)

Returns the JavaScript translation for the Soy variable with the given name,

maybeGet

@Nullable
public CodeChunk.WithValue maybeGet(String name)

Returns the JavaScript translation for the Soy variable with the given name, or null if no mapping exists for that variable. TODO(brndn): the null case is only for handling template params. Eliminate the @Nullable by seeding forNewTemplate() with the params.