JsSrcUtils (Closure Templates)

java.lang.Object
- com.google.template.soy.jssrc.internal.JsSrcUtils

```
public class JsSrcUtils
extends Object
```
Shared utilities specific to the JS Src backend.
Important: Do not use outside of Soy code (treat as superpackage-private).

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`escapeUnicodeFormatChars(String str)` Builds a version of the given string that has literal Unicode Format characters (Unicode category "Cf") changed to valid JavaScript Unicode escapes (i.e.
`static String`	`getJsTypeExpr(SoyType type)` Given a Soy type, return the corresponding jscompiler doc type expression.
`static String`	`getJsTypeExpr(SoyType type, boolean addParensIfNeeded, boolean addRequiredIfNeeded)`
`static String`	`getJsTypeName(SoyType type)` Given a Soy type, return the corresponding jscompiler type name.
`static String`	`getVariableName(String identity, Deque<Map<String,JsExpr>> localVarTranslations)` Traverses up the stack of local variable name mappings to get the generated local variable name for the given variable.
`static boolean`	`isDefaultOptional(SoyType type)` Returns true if the given type is optional by default (in the jscompiler).
`static boolean`	`isReservedWord(String key)` Returns true if key is a JavaScript reserved word.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - escapeUnicodeFormatChars
```
public static String escapeUnicodeFormatChars(String str)
```
    Builds a version of the given string that has literal Unicode Format characters (Unicode category "Cf") changed to valid JavaScript Unicode escapes (i.e. &92;u####). If the provided string doesn't have any Unicode Format characters, then the same string is returned.
    
    Parameters:
    str - The string to escape.
    
    Returns:
    A version of the given string that has literal Unicode Format characters (Unicode category "Cf") changed to valid JavaScript Unicode escapes (i.e. &92;u####).
  - getJsTypeExpr
```
public static String getJsTypeExpr(SoyType type)
```
    Given a Soy type, return the corresponding jscompiler doc type expression.
  - getJsTypeExpr
```
public static String getJsTypeExpr(SoyType type,
                   boolean addParensIfNeeded,
                   boolean addRequiredIfNeeded)
```
  - getJsTypeName
```
public static String getJsTypeName(SoyType type)
```
    Given a Soy type, return the corresponding jscompiler type name. Only handles types which have names and have a declared constructor - not arbitrary type expressions.
  - isDefaultOptional
```
public static boolean isDefaultOptional(SoyType type)
```
    Returns true if the given type is optional by default (in the jscompiler).
  - isReservedWord
```
public static boolean isReservedWord(String key)
```
    Returns true if key is a JavaScript reserved word.
  - getVariableName
```
public static String getVariableName(String identity,
                     Deque<Map<String,JsExpr>> localVarTranslations)
```
    Traverses up the stack of local variable name mappings to get the generated local variable name for the given variable.
    
    Parameters:
    identity - The local name of the variable
    localVarTranslations - The translations from local variables to generated variable name
    
    Returns:
    The generated name of the variable if it is found, or null if it is not

Class JsSrcUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

escapeUnicodeFormatChars

getJsTypeExpr

getJsTypeExpr

getJsTypeName

isDefaultOptional

isReservedWord

getVariableName