com.google.template.soy.data.internal

Class ListImpl

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.internal.ListImpl

All Implemented Interfaces:

SoyLegacyObjectMap, SoyList, SoyValue, SoyValueProvider

@ParametersAreNonnullByDefault
public final class ListImpl
extends SoyAbstractValue

Internal implementation of SoyList backed by a list of SoyValueProviders. Do not use directly; instead, use SoyValueConverter.convert(java.lang.Object).

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<? extends SoyValueProvider>	providerList Backing list of providers.

Method Summary

Modifier and Type	Method and Description
List<? extends SoyValueProvider>	asJavaList() Gets a Java list of all value providers in this SoyList.
List<SoyValue>	asResolvedJavaList() Gets a Java list all values in this SoyList.
boolean	coerceToBoolean() This implementation is always truthy (to match JS behavior).
String	coerceToString() Coerces this value into a string.
boolean	equals(Object other) This implementation uses object identity (to match JS behavior).
static ListImpl	forProviderList(com.google.common.collect.ImmutableList<? extends SoyValueProvider> providerList) Creates a Soy list implementation backed by the given list.
static ListImpl	forProviderList(List<? extends SoyValueProvider> providerList) Creates a Soy list implementation backed by the given list.
SoyValue	get(int index) Gets a value of this SoyList.
protected int	getIntegerIndex(SoyValue key) Gets the integer index out of a SoyValue key, or throws SoyDataException if the key is not an integer.
SoyValue	getItem(SoyValue key) Gets an item value of this SoyMap.
int	getItemCnt() Gets the number of items in this SoyMap.
Iterable<IntegerData>	getItemKeys() Gets an iterable over all item keys in this SoyMap.
SoyValueProvider	getItemProvider(SoyValue key) Gets a provider of an item value of this SoyMap.
SoyValueProvider	getProvider(int index) Gets a provider of a value of this SoyList.
int	hashCode()
boolean	hasItem(SoyValue key) Checks whether this SoyMap has an item with the given key.
int	length() Gets the length of this SoyList.
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.

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.SoyValue

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

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

renderAndResolve, resolve, status

Field Detail

providerList

protected final List<? extends SoyValueProvider> providerList

Backing list of providers.

Method Detail

forProviderList

public static ListImpl forProviderList(List<? extends SoyValueProvider> providerList)

Creates a Soy list implementation backed by the given list.

forProviderList

public static ListImpl forProviderList(com.google.common.collect.ImmutableList<? extends SoyValueProvider> providerList)

Creates a Soy list implementation backed by the given list.

length

public final int length()

Description copied from interface: SoyList

Gets the length of this SoyList.

Specified by:

length in interface SoyList

Returns:

The length.

asJavaList

@Nonnull
public final List<? extends SoyValueProvider> asJavaList()

Description copied from interface: SoyList

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.

Specified by:

asJavaList in interface SoyList

Returns:

A Java list of all value providers.

asResolvedJavaList

@Nonnull
public final List<SoyValue> asResolvedJavaList()

Description copied from interface: SoyList

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

Specified by:

asResolvedJavaList in interface SoyList

Returns:

A Java list of all resolved values.

get

public final SoyValue get(int index)

Description copied from interface: SoyList

Gets a value of this SoyList.

Specified by:

get in interface SoyList

Parameters:

index - The index to get.

Returns:

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

getProvider

public final SoyValueProvider getProvider(int index)

Description copied from interface: SoyList

Gets a provider of a value of this SoyList.

Specified by:

getProvider in interface SoyList

Parameters:

index - The index to get.

Returns:

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

getItemCnt

public final int getItemCnt()

Description copied from interface: SoyLegacyObjectMap

Gets the number of items in this SoyMap.

Specified by:

getItemCnt in interface SoyLegacyObjectMap

Returns:

The number of items.

getItemKeys

@Nonnull
public final Iterable<IntegerData> getItemKeys()

Description copied from interface: SoyLegacyObjectMap

Gets an iterable over all item keys in this SoyMap.

Important: Iteration order is undefined.

Specified by:

getItemKeys in interface SoyLegacyObjectMap

Returns:

An iterable over all item keys.

hasItem

public final boolean hasItem(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

Checks whether this SoyMap has an item with the given key.

Specified by:

hasItem in interface SoyLegacyObjectMap

Parameters:

key - The item key to check.

Returns:

Whether this SoyMap has an item with the given key.

getItem

public final SoyValue getItem(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

Gets an item value of this SoyMap.

Specified by:

getItem in interface SoyLegacyObjectMap

Parameters:

key - The item key to get.

Returns:

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

getItemProvider

public final SoyValueProvider getItemProvider(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

Gets a provider of an item value of this SoyMap.

Specified by:

getItemProvider in interface SoyLegacyObjectMap

Parameters:

key - The item key to get.

Returns:

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

getIntegerIndex

protected final int getIntegerIndex(SoyValue key)

Gets the integer index out of a SoyValue key, or throws SoyDataException if the key is not an integer.

Parameters:

key - The SoyValue key.

Returns:

The index.

equals

public final boolean equals(Object other)

This implementation uses object identity (to match JS behavior).

Note: Users will eventually be able to create their own implementations if they desire.

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

coerceToBoolean

public final boolean coerceToBoolean()

This implementation is always truthy (to match JS behavior).

Note: Users will eventually be able to create their own implementations if they desire.

Specified by:

coerceToBoolean in interface SoyValue

Returns:

This value coerced into a boolean.

coerceToString

public final 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