JsCodeBuilder (Closure Templates)

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

public class JsCodeBuilder
extends Object

A JavaScript implementation of the CodeBuilder class.

Usage example that demonstrates most of the methods:

   JsCodeBuilder jcb = new JsCodeBuilder(CodeStyle.STRINGBUILDER);
   jcb.appendLine("story.title = function(opt_data) {");
   jcb.increaseIndent();
   jcb.pushOutputVar("output");
   jcb.initOutputVarIfNecessary();
   jcb.pushOutputVar("temp");
   jcb.addToOutputVar(Lists.newArrayList(
       new JsExpr("'Snow White and the '", Integer.MAX_VALUE),
       new JsExpr("opt_data.numDwarfs", Integer.MAX_VALUE));
   jcb.popOutputVar();
   jcb.addToOutputVar(Lists.newArrayList(
       new JsExpr("temp", Integer.MAX_VALUE),
       new JsExpr("' Dwarfs'", Integer.MAX_VALUE));
   jcb.appendLineStart("return ").appendOutputVarName().appendLineEnd(".toString();");
   jcb.popOutputVar();
   jcb.decreaseIndent();
   String THE_END = "the end";
   jcb.appendLine("}  // ", THE_END);

The above example builds the following JS code:

 story.title = function(opt_data) {
   var output = new soy.StringBuilder();
   var temp = new soy.StringBuilder('Snow White and the ', opt_data.numDwarfs);
   output.append(temp, ' Dwarfs');
   return output.toString();
 }  // the end

Field Summary

Fields
Modifier and Type Field and Description

protected CodeChunk.WithValue currOutputVar
The current output variable.

Fields
Modifier and Type	Field and Description
`protected CodeChunk.WithValue`	`currOutputVar` The current output variable.

Constructor Summary

Constructors
Modifier Constructor and Description

protected JsCodeBuilder()

protected JsCodeBuilder(JsCodeBuilder parent)

Constructors
Modifier	Constructor and Description
`protected`	`JsCodeBuilder()`
`protected`	`JsCodeBuilder(JsCodeBuilder parent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsCodeBuilder`	`addChunksToOutputVar(List<? extends CodeChunk.WithValue> codeChunks)` Appends one or more lines representing the concatenation of the values of the given code chunks saved to the current output variable.
`JsCodeBuilder`	`addChunkToOutputVar(CodeChunk.WithValue chunk)` Appends the given code chunk to the current output variable.
`void`	`addGoogRequire(GoogRequire require)` Adds a `goog.require`
`JsCodeBuilder`	`append(CodeChunk codeChunk)` Serializes the given `CodeChunk` into the code builder, respecting the code builder's current indentation level.
`JsCodeBuilder`	`append(String... codeFragments)` Appends one or more strings to the generated code.
`JsCodeBuilder`	`appendLine(String... codeFragments)` Appends the current indent, then the given strings, then a newline.
`JsCodeBuilder`	`appendLineEnd(String... codeFragments)` Appends the given strings, then a newline.
`JsCodeBuilder`	`appendLineStart(String... codeFragments)` Appends the current indent, then the given strings.
`JsCodeBuilder`	`decreaseIndent()` Decreases the current indent.
`JsCodeBuilder`	`decreaseIndentTwice()` Decreases the current indent twice.
`String`	`getCode()`
`CodeChunk.RequiresCollector`	`getRequiresCollector()`
`JsCodeBuilder`	`increaseIndent()` Increases the current indent.
`JsCodeBuilder`	`increaseIndentTwice()` Increases the current indent twice.
`void`	`initOutputVarIfNecessary()`
`JsCodeBuilder`	`popOutputVar()` Pops off the current output variable.
`JsCodeBuilder`	`pushOutputVar(String outputVarName)` Pushes on a new current output variable.
`JsCodeBuilder`	`setOutputVarInited()` Tells this CodeBuilder that the current output variable has already been initialized.

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

- Field Detail
  - currOutputVar
```
@Nullable
protected CodeChunk.WithValue currOutputVar
```
    The current output variable.
    TODO(user): this is always an CodeChunk.id(java.lang.String). Consider exposing a subclass of CodeChunk so we can enforce this invariant at compile time.
- Constructor Detail
  - JsCodeBuilder
```
protected JsCodeBuilder()
```
  - JsCodeBuilder
```
protected JsCodeBuilder(JsCodeBuilder parent)
```
- Method Detail
  - initOutputVarIfNecessary
```
public void initOutputVarIfNecessary()
```
  - addChunkToOutputVar
```
public JsCodeBuilder addChunkToOutputVar(CodeChunk.WithValue chunk)
```
    Appends the given code chunk to the current output variable.
  - addChunksToOutputVar
```
public JsCodeBuilder addChunksToOutputVar(List<? extends CodeChunk.WithValue> codeChunks)
```
    Appends one or more lines representing the concatenation of the values of the given code chunks saved to the current output variable.
  - increaseIndent
```
public final JsCodeBuilder increaseIndent()
```
    Increases the current indent.
  - increaseIndentTwice
```
public final JsCodeBuilder increaseIndentTwice()
```
    Increases the current indent twice.
  - decreaseIndent
```
public final JsCodeBuilder decreaseIndent()
```
    Decreases the current indent.
  - decreaseIndentTwice
```
public final JsCodeBuilder decreaseIndentTwice()
```
    Decreases the current indent twice.
  - pushOutputVar
```
public JsCodeBuilder pushOutputVar(String outputVarName)
```
    Pushes on a new current output variable.
    
    Parameters:
    
    outputVarName - The new output variable name.
  - popOutputVar
```
public JsCodeBuilder popOutputVar()
```
    Pops off the current output variable. The previous output variable again becomes the current.
  - setOutputVarInited
```
public JsCodeBuilder setOutputVarInited()
```
    Tells this CodeBuilder that the current output variable has already been initialized. This causes initOutputVarIfNecessary and addToOutputVar to not add initialization code even on the first use of the variable.
  - append
```
public JsCodeBuilder append(CodeChunk codeChunk)
```
    Serializes the given CodeChunk into the code builder, respecting the code builder's current indentation level.
  - append
```
public JsCodeBuilder append(String... codeFragments)
```
    Appends one or more strings to the generated code.
    
    Parameters:
    
    codeFragments - The code string(s) to append.
    
    Returns:
    
    This CodeBuilder (for stringing together operations).
  - appendLine
```
public JsCodeBuilder appendLine(String... codeFragments)
```
    Appends the current indent, then the given strings, then a newline.
    
    Parameters:
    
    codeFragments - The code string(s) to append.
    
    Returns:
    
    This CodeBuilder (for stringing together operations).
  - appendLineStart
```
public JsCodeBuilder appendLineStart(String... codeFragments)
```
    Appends the current indent, then the given strings.
    
    Parameters:
    
    codeFragments - The code string(s) to append.
    
    Returns:
    
    This CodeBuilder (for stringing together operations).
  - appendLineEnd
```
public JsCodeBuilder appendLineEnd(String... codeFragments)
```
    Appends the given strings, then a newline.
    
    Parameters:
    
    codeFragments - The code string(s) to append.
    
    Returns:
    
    This CodeBuilder (for stringing together operations).
  - getRequiresCollector
```
public CodeChunk.RequiresCollector getRequiresCollector()
```
  - addGoogRequire
```
public void addGoogRequire(GoogRequire require)
```
    Adds a goog.require
    
    Parameters:
    
    require - The namespace being required
  - getCode
```
public String getCode()
```
    Returns:
    
    The generated code.

Class JsCodeBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currOutputVar

Constructor Detail

JsCodeBuilder

JsCodeBuilder

Method Detail

initOutputVarIfNecessary

addChunkToOutputVar

addChunksToOutputVar

increaseIndent

increaseIndentTwice

decreaseIndent

decreaseIndentTwice

pushOutputVar

popOutputVar

setOutputVarInited

append

append

appendLine

appendLineStart

appendLineEnd

getRequiresCollector

addGoogRequire

getCode