com.google.template.soy.data.internal

Class ParamStore

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyAbstractRecord

com.google.template.soy.data.internal.ParamStore

All Implemented Interfaces:

SoyRecord, SoyValue, SoyValueProvider

Direct Known Subclasses:

AugmentedParamStore, BasicParamStore

public abstract class ParamStore
extends SoyAbstractRecord

Internal-use param store for passing data in subtemplate calls.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.data.SoyValueProvider

SoyValueProvider.ResolveStatus

Field Summary

Fields

Modifier and Type	Field and Description
static ParamStore	EMPTY_INSTANCE

Constructor Summary

Constructors

Constructor and Description
ParamStore()

Method Summary

Modifier and Type	Method and Description
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
boolean	equals(SoyValue other) Compares this value against another for equality in the sense of the '==' operator of Soy.
void	render(Appendable appendable) Renders this value to the given appendable.
abstract void	setField(String name, SoyValueProvider valueProvider) Sets a field (i.e.

Methods inherited from class com.google.template.soy.data.SoyAbstractRecord

getField

Methods inherited from class com.google.template.soy.data.SoyAbstractValue

booleanValue, equals, floatValue, integerValue, longValue, numberValue, render, resolve, status, stringValue

Methods inherited from class java.lang.Object

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

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

getFieldProvider, hasField

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

booleanValue, floatValue, integerValue, longValue, numberValue, render, stringValue

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

equals, resolve, status

Field Detail

EMPTY_INSTANCE

public static final ParamStore EMPTY_INSTANCE

Constructor Detail

ParamStore

public ParamStore()

Method Detail

setField

public abstract void setField(String name,
                              @Nonnull
                              SoyValueProvider valueProvider)

Sets a field (i.e. param) in this ParamStore.

Parameters:

name - The field name to set.

valueProvider - A provider of the field value.

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

Returns:

This value coerced into a boolean.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Returns:

This value coerced into a string.

render

public void render(Appendable appendable)
            throws IOException

Description copied from interface: SoyValue

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

equals

public boolean equals(SoyValue other)

Description copied from interface: SoyValue

Compares this value against another for equality in the sense of the '==' operator of Soy.

Parameters:

other - The other value to compare against.

Returns:

True if this value is equal to the other in the sense of Soy.