com.google.template.soy.data.internal

Class ParamStore

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

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

All Implemented Interfaces:

SoyRecord, SoyValue, SoyValueProvider

Direct Known Subclasses:

AugmentedParamStore, BasicParamStore

public abstract class ParamStore
extends SoyAbstractValue
implements SoyRecord

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

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

TODO(lukes): there is no need for this class to implement SoyRecord...

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(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
SoyValue	getField(String name) Gets a field value of this SoyRecord.
int	hashCode()
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.
abstract ParamStore	setField(String name, SoyValueProvider valueProvider) Sets a field (i.e.

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

renderAndResolve, resolve, status

Field Detail

EMPTY_INSTANCE

public static final ParamStore EMPTY_INSTANCE

Constructor Detail

ParamStore

public ParamStore()

Method Detail

setField

public abstract ParamStore 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.

getField

public SoyValue getField(String name)

Description copied from interface: SoyRecord

Gets a field value of this SoyRecord.

Specified by:

getField in interface SoyRecord

Parameters:

name - The field name to get.

Returns:

The field value for the given field name, or null if no such field name.

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

Specified by:

coerceToBoolean in interface SoyValue

Returns:

This value coerced into a boolean.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Specified by:

coerceToString in interface SoyValue

Returns:

This value coerced into a string.

render

public void render(LoggingAdvisingAppendable 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.

Specified by:

render in interface SoyValue

Parameters:

appendable - The appendable to render to.

Throws:

IOException

equals

public final boolean equals(Object other)

Description copied from interface: SoyValue

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

Specified by:

equals in interface SoyValue

Specified by:

equals in class SoyAbstractValue

Parameters:

other - The other value to compare against.

Returns:

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object