com.google.template.soy.data

Interface SoyRecord

All Superinterfaces:

SoyValue, SoyValueProvider

All Known Subinterfaces:

SoyDict

All Known Implementing Classes:

AugmentedParamStore, BasicParamStore, DictImpl, ParamStore, SoyMapData, SoyProtoValueImpl

@ParametersAreNonnullByDefault
public interface SoyRecord
extends SoyValue

A record containing name-to-value mappings referred to as fields. Each name is a string and each value is a SoyValue (can be unresolved).

Important: Until this API is more stable and this note is removed, users must not define classes that implement this interface.

Method Summary

Modifier and Type	Method and Description
SoyValue	getField(String name) Gets a field value of this SoyRecord.
SoyValueProvider	getFieldProvider(String name) Gets a provider of a field value of this SoyRecord.
boolean	hasField(String name) Checks whether this SoyRecord has a field of the given name.

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

booleanValue, coerceToBoolean, coerceToString, equals, floatValue, integerValue, longValue, numberValue, render, render, stringValue

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

renderAndResolve, resolve, status

Method Detail

hasField

boolean hasField(String name)

Checks whether this SoyRecord has a field of the given name.

Parameters:

name - The field name to check.

Returns:

Whether this SoyRecord has a field of the given name.

getField

SoyValue getField(String name)

Gets a field value of this SoyRecord.

Parameters:

name - The field name to get.

Returns:

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

getFieldProvider

SoyValueProvider getFieldProvider(String name)

Gets a provider of a field value of this SoyRecord.

Parameters:

name - The field name to get.

Returns:

A provider of the field value for the given field name, or null if no such field name.