com.google.template.soy.data

Interface SoyList

All Superinterfaces:

SoyLegacyObjectMap, SoyValue, SoyValueProvider

All Known Subinterfaces:

SoyEasyList

All Known Implementing Classes:

EasyListImpl, ListImpl, SoyListData

@ParametersAreNonnullByDefault
public interface SoyList
extends SoyLegacyObjectMap

A list containing values. Each value is a SoyValue (can be unresolved).

A list also supports the map interface. In that usage, the item keys are the list indices in the form of IntegerData.

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
List<? extends SoyValueProvider>	asJavaList() Gets a Java list of all value providers in this SoyList.
List<? extends SoyValue>	asResolvedJavaList() Gets a Java list all values in this SoyList.
SoyValue	get(int index) Gets a value of this SoyList.
SoyValueProvider	getProvider(int index) Gets a provider of a value of this SoyList.
int	length() Gets the length of this SoyList.

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

getItem, getItemCnt, getItemKeys, getItemProvider, hasItem

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

length

int length()

Gets the length of this SoyList.

Returns:

The length.

asJavaList

@Nonnull
List<? extends SoyValueProvider> asJavaList()

Gets a Java list of all value providers in this SoyList. Note that value providers are often just the values themselves, since all values are also providers.

Returns:

A Java list of all value providers.

asResolvedJavaList

@Nonnull
List<? extends SoyValue> asResolvedJavaList()

Gets a Java list all values in this SoyList. All value providers will be eagerly resolved.

Returns:

A Java list of all resolved values.

get

SoyValue get(int index)

Gets a value of this SoyList.

Parameters:

index - The index to get.

Returns:

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

getProvider

SoyValueProvider getProvider(int index)

Gets a provider of a value of this SoyList.

Parameters:

index - The index to get.

Returns:

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