SoyValue (Closure Templates)

All Superinterfaces:

SoyValueProvider

All Known Subinterfaces:

SoyDict, SoyEasyDict, SoyEasyList, SoyList, SoyMap, SoyProtoTypeImpl.Value, SoyRecord, SoyString

All Known Implementing Classes:

AugmentedParamStore, BasicParamStore, BooleanData, CollectionData, DictImpl, EasyDictImpl, EasyListImpl, FloatData, IntegerData, ListImpl, NullData, NumberData, ParamStore, PrimitiveData, SanitizedContent, SoyAbstractCachingRecord, SoyAbstractList, SoyAbstractMap, SoyAbstractRecord, SoyAbstractValue, SoyData, SoyListData, SoyMapData, SoyProtoValue, StringData, UndefinedData
```
@ParametersAreNonnullByDefault
public interface SoyValue
extends SoyValueProvider
```
Superinterface of all Soy value interfaces/classes. Replaces the old SoyData.
Important: Until this API is more stable and this note is removed, users must not define classes that implement this interface.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Precondition: Only call this method if you know that this SoyValue object is a boolean.
`boolean`	`coerceToBoolean()` Coerces this value into a boolean.
`String`	`coerceToString()` Coerces this value into a string.
`boolean`	`equals(Object other)` Compares this value against another for equality in the sense of the '==' operator of Soy.
`double`	`floatValue()` Precondition: Only call this method if you know that this SoyValue object is a float.
`int`	`integerValue()` Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer.
`long`	`longValue()` Precondition: Only call this method if you know that this SoyValue object is an integer or long.
`double`	`numberValue()` Precondition: Only call this method if you know that this SoyValue object is a number.
`void`	`render(Appendable appendable)` Renders this value to the given appendable.
`String`	`stringValue()` Precondition: Only call this method if you know that this SoyValue object is a string.

Methods inherited from interface com.google.template.soy.data.SoyValueProvider
renderAndResolve, resolve, status

- Method Detail
  - equals
```
boolean equals(Object other)
```
    Compares this value against another for equality in the sense of the '==' operator of Soy.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - The other value to compare against.
    
    Returns:
    True if this value is equal to the other in the sense of Soy.
  - coerceToBoolean
```
boolean coerceToBoolean()
```
    Coerces this value into a boolean.
    
    Returns:
    This value coerced into a boolean.
  - coerceToString
```
String coerceToString()
```
    Coerces this value into a string.
    
    Returns:
    This value coerced into a string.
  - render
```
void render(Appendable appendable)
            throws IOException
```
    Renders this value to the given appendable.
    This should behave identically to appendable.append(coerceToString()) but is provided separately to allow more incremental approaches.
    
    Parameters:
    appendable - The appendable to render to.
    
    Throws:
    
    IOException
  - booleanValue
```
boolean booleanValue()
```
    Precondition: Only call this method if you know that this SoyValue object is a boolean. This method gets the boolean value of this boolean object.
    
    Returns:
    The boolean value of this boolean object.
    
    Throws:
    
    SoyDataException - If this object is not actually a boolean.
  - integerValue
```
int integerValue()
```
    Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer. This method gets the integer value of this integer object.
    
    Returns:
    The integer value of this integer object.
    
    Throws:
    
    SoyDataException - If this object is not actually an integer.
  - longValue
```
long longValue()
```
    Precondition: Only call this method if you know that this SoyValue object is an integer or long. This method gets the integer value of this integer object.
    
    Returns:
    The integer value of this integer object.
    
    Throws:
    
    SoyDataException - If this object is not actually an integer.
  - floatValue
```
double floatValue()
```
    Precondition: Only call this method if you know that this SoyValue object is a float. This method gets the float value of this float object.
    
    Returns:
    The float value of this float object.
    
    Throws:
    
    SoyDataException - If this object is not actually a float.
  - numberValue
```
double numberValue()
```
    Precondition: Only call this method if you know that this SoyValue object is a number. This method gets the float value of this number object (converting integer to float if necessary).
    
    Returns:
    The float value of this number object.
    
    Throws:
    
    SoyDataException - If this object is not actually a number.
  - stringValue
```
String stringValue()
```
    Precondition: Only call this method if you know that this SoyValue object is a string. This method gets the string value of this string object.
    
    Returns:
    The string value of this string object.
    
    Throws:
    
    SoyDataException - If this object is not actually a string.

Interface SoyValue

Method Summary

Methods inherited from interface com.google.template.soy.data.SoyValueProvider

Method Detail

equals

coerceToBoolean

coerceToString

render

booleanValue

integerValue

longValue

floatValue

numberValue

stringValue