com.google.template.soy.data

Interface SoyValueProvider

All Known Subinterfaces:

SoyDict, SoyEasyDict, SoyEasyList, SoyList, SoyMap, SoyRecord, SoyValue

All Known Implementing Classes:

AugmentedParamStore, BasicParamStore, BooleanData, CollectionData, DictImpl, EasyDictImpl, EasyListImpl, FloatData, IntegerData, ListImpl, NullData, NumberData, ParamStore, PrimitiveData, SanitizedContent, SoyAbstractCachingRecord, SoyAbstractCachingValueProvider, SoyAbstractList, SoyAbstractMap, SoyAbstractRecord, SoyAbstractValue, SoyData, SoyFutureValueProvider, SoyListData, SoyMapData, StringData, UndefinedData

@ParametersAreNonnullByDefault
public interface SoyValueProvider

A provider of a Soy value.

This allows for adding providers of late-resolved values (e.g. Futures) to records/maps/lists that are only resolved if the values are actually retrieved. Note that each Soy value object should itself be a provider (of itself).

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
boolean	equals(SoyValueProvider other) Compares this value against another for equality for the purposes of Soy.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.

Method Detail

resolve

@Nonnull
SoyValue resolve()

Usually, this method is a no-op that simply returns this object. However, if this value needs to be resolved at usage time, then this method resolves and returns the resolved value.

Returns:

The resolved value.

equals

boolean equals(SoyValueProvider other)

Compares this value against another for equality for the purposes of Soy.

Parameters:

other - The other value to compare against.

Returns:

True if the two values are equal.