SoyExpression (Closure Templates)

java.lang.Object
- com.google.template.soy.jbcsrc.restricted.BytecodeProducer
- - com.google.template.soy.jbcsrc.restricted.Expression
  - - com.google.template.soy.jbcsrc.restricted.SoyExpression

```
public final class SoyExpression
extends Expression
```
An Expression involving a soy value.
SoyExpressions can be boxed into SoyValue subtypes and they also support some implicit conversions.
All soy expressions are convertible to boolean or String valued expressions, but depending on the type they may also support additional unboxing conversions.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.template.soy.jbcsrc.restricted.Expression
  Expression.Feature, Expression.Features

Field Summary

Fields
Modifier and Type Field and Description

static SoyExpression FALSE

static SoyExpression NULL

static SoyExpression NULL_BOXED

static SoyExpression TRUE
- Fields inherited from class com.google.template.soy.jbcsrc.restricted.BytecodeProducer
  location

Fields
Modifier and Type	Field and Description
`static SoyExpression`	`FALSE`
`static SoyExpression`	`NULL`
`static SoyExpression`	`NULL_BOXED`
`static SoyExpression`	`TRUE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Expression`	`asBoxedList(List<SoyExpression> items)` Returns an Expression that evaluates to a list containing all the items as boxed soy values.
`SoyExpression`	`asCheap()` Returns an equivalent expression where `Expression.isCheap()` returns `true`.
`SoyExpression`	`asNonNullable()` Returns an equivalent expression where `Expression.isNonNullable()` returns `true`.
`SoyExpression`	`asNullable()`
`boolean`	`assignableToNullableFloat()`
`boolean`	`assignableToNullableInt()`
`boolean`	`assignableToNullableNumber()`
`boolean`	`assignableToNullableString()`
`SoyExpression`	`box()` Returns a SoyExpression that evaluates to a subtype of `SoyValue`.
`Expression`	`boxAsSoyValueProvider()` Returns an Expression of a non-null `SoyValueProvider` providing this value.
`SoyExpression`	`coerceToBoolean()` Coerce this expression to a boolean value.
`SoyExpression`	`coerceToDouble()` Coerce this expression to a double value.
`SoyExpression`	`coerceToString()` Coerce this expression to a string value.
`protected void`	`doGen(CodeBuilder adapter)` Generate code to evaluate the expression.
`static SoyExpression`	`forBool(Expression delegate)`
`static SoyExpression`	`forFloat(Expression delegate)`
`static SoyExpression`	`forInt(Expression delegate)`
`static SoyExpression`	`forLegacyObjectMap(LegacyObjectMapType mapType, Expression delegate)`
`static SoyExpression`	`forList(ListType listType, Expression delegate)`
`static SoyExpression`	`forMap(MapType mapType, Expression delegate)`
`static SoyExpression`	`forProto(SoyRuntimeType type, Expression delegate)`
`static SoyExpression`	`forSanitizedString(Expression delegate, SanitizedContentKind kind)`
`static SoyExpression`	`forSoyValue(SoyType type, Expression delegate)`
`static SoyExpression`	`forString(Expression delegate)`
`boolean`	`isBoxed()`
`SoyExpression`	`labelEnd(org.objectweb.asm.Label label)` Returns a new expression identical to this one but with the given label applied at the end of the expression.
`SoyExpression`	`labelStart(org.objectweb.asm.Label label)` Returns a new expression identical to this one but with the given label applied at the start of the expression.
`SoyRuntimeType`	`soyRuntimeType()` Returns the `SoyRuntimeType` of the expression.
`SoyType`	`soyType()` Returns the `SoyType` of the expression.
`SoyExpression`	`unboxAs(Class<?> asType)` Unboxes this to a `SoyExpression` with a runtime type of `asType`.
`SoyExpression`	`withSource(Expression expr)` Returns a new `SoyExpression` with the same type but a new delegate expression.
`SoyExpression`	`withSourceLocation(SourceLocation location)` Returns an identical `Expression` with the given source location.

Methods inherited from class com.google.template.soy.jbcsrc.restricted.Expression
areAllCheap, areAllCheap, checkAssignableTo, checkAssignableTo, checkedCast, checkedCast, checkTypes, extraToStringProperties, features, invoke, invokeVoid, isCheap, isNonNullable, resultType, toStatement, toString

Methods inherited from class com.google.template.soy.jbcsrc.restricted.BytecodeProducer
gen, trace

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

- Field Detail
  - NULL
```
public static final SoyExpression NULL
```
  - NULL_BOXED
```
public static final SoyExpression NULL_BOXED
```
  - TRUE
```
public static final SoyExpression TRUE
```
  - FALSE
```
public static final SoyExpression FALSE
```
- Method Detail
  - forSoyValue
```
public static SoyExpression forSoyValue(SoyType type,
                                        Expression delegate)
```
  - forBool
```
public static SoyExpression forBool(Expression delegate)
```
  - forFloat
```
public static SoyExpression forFloat(Expression delegate)
```
  - forInt
```
public static SoyExpression forInt(Expression delegate)
```
  - forString
```
public static SoyExpression forString(Expression delegate)
```
  - forSanitizedString
```
public static SoyExpression forSanitizedString(Expression delegate,
                                               SanitizedContentKind kind)
```
  - forList
```
public static SoyExpression forList(ListType listType,
                                    Expression delegate)
```
  - forLegacyObjectMap
```
public static SoyExpression forLegacyObjectMap(LegacyObjectMapType mapType,
                                               Expression delegate)
```
  - forMap
```
public static SoyExpression forMap(MapType mapType,
                                   Expression delegate)
```
  - forProto
```
public static SoyExpression forProto(SoyRuntimeType type,
                                     Expression delegate)
```
  - asBoxedList
```
public static Expression asBoxedList(List<SoyExpression> items)
```
    Returns an Expression that evaluates to a list containing all the items as boxed soy values.
  - soyType
```
public final SoyType soyType()
```
    Returns the SoyType of the expression.
  - soyRuntimeType
```
public final SoyRuntimeType soyRuntimeType()
```
    Returns the SoyRuntimeType of the expression.
  - doGen
```
protected final void doGen(CodeBuilder adapter)
```
    Description copied from class: Expression
    
    Generate code to evaluate the expression.
    The generated code satisfies the invariant that the top of the runtime stack will contain a value with this Expression.resultType() immediately after evaluation of the code.
    
    Specified by:
    
    doGen in class Expression
  - withSourceLocation
```
public SoyExpression withSourceLocation(SourceLocation location)
```
    Description copied from class: Expression
    
    Returns an identical Expression with the given source location.
    
    Overrides:
    
    withSourceLocation in class Expression
  - assignableToNullableInt
```
public boolean assignableToNullableInt()
```
  - assignableToNullableFloat
```
public boolean assignableToNullableFloat()
```
  - assignableToNullableNumber
```
public boolean assignableToNullableNumber()
```
  - assignableToNullableString
```
public boolean assignableToNullableString()
```
  - isBoxed
```
public boolean isBoxed()
```
  - boxAsSoyValueProvider
```
public Expression boxAsSoyValueProvider()
```
    Returns an Expression of a non-null SoyValueProvider providing this value.
  - box
```
public SoyExpression box()
```
    Returns a SoyExpression that evaluates to a subtype of SoyValue.
  - coerceToBoolean
```
public SoyExpression coerceToBoolean()
```
    Coerce this expression to a boolean value.
  - coerceToString
```
public SoyExpression coerceToString()
```
    Coerce this expression to a string value.
  - coerceToDouble
```
public SoyExpression coerceToDouble()
```
    Coerce this expression to a double value. Useful for float-int comparisons.
  - unboxAs
```
public SoyExpression unboxAs(Class<?> asType)
```
    Unboxes this to a SoyExpression with a runtime type of asType.
    This method is appropriate when you know (likely via inspection of the soyType(), or other means) that the value does have the appropriate type but you prefer to interact with it as its unboxed representation. If you simply want to 'coerce' the given value to a new type consider coerceToBoolean() coerceToDouble() or coerceToString() which are designed for that use case.
  - withSource
```
public SoyExpression withSource(Expression expr)
```
    Returns a new SoyExpression with the same type but a new delegate expression.
  - asCheap
```
public SoyExpression asCheap()
```
    Description copied from class: Expression
    
    Returns an equivalent expression where Expression.isCheap() returns true.
    
    Overrides:
    
    asCheap in class Expression
  - asNonNullable
```
public SoyExpression asNonNullable()
```
    Description copied from class: Expression
    
    Returns an equivalent expression where Expression.isNonNullable() returns true.
    
    Overrides:
    
    asNonNullable in class Expression
  - asNullable
```
public SoyExpression asNullable()
```
    Overrides:
    
    asNullable in class Expression
  - labelStart
```
public SoyExpression labelStart(org.objectweb.asm.Label label)
```
    Description copied from class: Expression
    
    Returns a new expression identical to this one but with the given label applied at the start of the expression.
    
    Overrides:
    
    labelStart in class Expression
  - labelEnd
```
public SoyExpression labelEnd(org.objectweb.asm.Label label)
```
    Description copied from class: Expression
    
    Returns a new expression identical to this one but with the given label applied at the end of the expression.
    
    Overrides:
    
    labelEnd in class Expression

Class SoyExpression

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.jbcsrc.restricted.Expression

Field Summary

Fields inherited from class com.google.template.soy.jbcsrc.restricted.BytecodeProducer

Method Summary

Methods inherited from class com.google.template.soy.jbcsrc.restricted.Expression

Methods inherited from class com.google.template.soy.jbcsrc.restricted.BytecodeProducer

Methods inherited from class java.lang.Object

Field Detail

NULL

NULL_BOXED

TRUE

FALSE

Method Detail

forSoyValue

forBool

forFloat

forInt

forString

forSanitizedString

forList

forLegacyObjectMap

forMap

forProto

asBoxedList

soyType

soyRuntimeType

doGen

withSourceLocation

assignableToNullableInt

assignableToNullableFloat

assignableToNullableNumber

assignableToNullableString

isBoxed

boxAsSoyValueProvider

box

coerceToBoolean

coerceToString

coerceToDouble

unboxAs

withSource

asCheap

asNonNullable

asNullable

labelStart

labelEnd