com.google.template.soy.data

Class SoyListData

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyData

com.google.template.soy.data.restricted.CollectionData

com.google.template.soy.data.SoyListData

All Implemented Interfaces:

SoyLegacyObjectMap, SoyList, SoyValue, SoyValueProvider, Iterable<SoyData>

public final class SoyListData
extends CollectionData
implements Iterable<SoyData>, SoyList

A list data node in a Soy data tree.

Constructor Summary

Constructors

Constructor and Description
SoyListData()
SoyListData(Iterable<?> data) Constructor that initializes this SoyListData from an existing list.
SoyListData(Object... values) Constructor that initializes this SoyListData with the given elements.

Method Summary

Modifier and Type	Method and Description
void	add(boolean value) Adds a data value.
void	add(double value) Adds a data value.
void	add(int value) Adds a data value.
void	add(long value) Adds a data value.
void	add(Object... values) Convenience function to add multiple values in one call.
void	add(SoyData value) Adds a data value.
void	add(String value) Adds a data value.
List<? extends SoyValueProvider>	asJavaList() Gets a Java list of all value providers in this SoyList.
List<SoyData>	asList() Important: Please treat this method as superpackage-private.
List<? extends SoyValue>	asResolvedJavaList() Gets a Java list all values in this SoyList.
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.
SoyData	get(int index) Gets the data value at a given index.
boolean	getBoolean(int index) Precondition: The specified index contains a boolean.
double	getFloat(int index) Precondition: The specified index contains a float.
int	getInteger(int index) Precondition: The specified index contains an integer.
SoyValue	getItem(SoyValue key) Gets an item value of this SoyMap.
int	getItemCnt() Gets the number of items in this SoyMap.
Iterable<? extends SoyValue>	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.
SoyListData	getListData(int index) Precondition: The specified index contains a SoyListData object.
long	getLong(int index) Precondition: The specified index contains a long.
SoyMapData	getMapData(int index) Precondition: The specified index contains a SoyMapData object.
SoyValueProvider	getProvider(int index) Gets a provider of a value of this SoyList.
SoyData	getSingle(String key) Important: Do not use outside of Soy code (treat as superpackage-private).
String	getString(int index) Precondition: The specified index contains a string.
int	hashCode()
boolean	hasItem(SoyValue key) Checks whether this SoyMap has an item with the given key.
Iterator<SoyData>	iterator()
int	length() Gets the length of this list.
void	putSingle(String key, SoyData value) Important: Do not use outside of Soy code (treat as superpackage-private).
void	remove(int index) Removes the data value at a given index.
void	removeSingle(String key) Important: Do not use outside of Soy code (treat as superpackage-private).
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.
void	set(int index, boolean value) Sets a data value at a given index.
void	set(int index, double value) Sets a data value at a given index.
void	set(int index, int value) Sets a data value at a given index.
void	set(int index, SoyData value) Sets a data value at a given index.
void	set(int index, String value) Sets a data value at a given index.
String	toString()

Methods inherited from class com.google.template.soy.data.restricted.CollectionData

ensureValidValue, get, getBoolean, getFloat, getInteger, getListData, getLong, getMapData, getString, put, put, put, put, put, put, put, remove

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

createFromExistingData

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, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

Constructor Detail

SoyListData

public SoyListData()

SoyListData

public SoyListData(Iterable<?> data)

Constructor that initializes this SoyListData from an existing list.

Parameters:

data - The initial data in an existing Iterable.

SoyListData

public SoyListData(Object... values)

Constructor that initializes this SoyListData with the given elements.

Parameters:

values - The initial data to add.

Method Detail

asList

public List<SoyData> asList()

Important: Please treat this method as superpackage-private. Do not call this method from outside the 'tofu' and 'data' packages.

Returns a view of this SoyListData object as a List.

toString

public String toString()

This method should only be used for debugging purposes.

Overrides:

toString in class Object

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

coerceToBoolean

public boolean coerceToBoolean()

Coerces this value into a boolean.

A list is always truthy.

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.

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

length

public int length()

Gets the length of this list.

Specified by:

length in interface SoyList

Returns:

The length of this list.

iterator

public Iterator<SoyData> iterator()

Specified by:

iterator in interface Iterable<SoyData>

add

public void add(Object... values)

Convenience function to add multiple values in one call.

Parameters:

values - The data to add.

add

public void add(SoyData value)

Adds a data value.

Parameters:

value - The data to add.

add

public void add(boolean value)

Adds a data value.

Parameters:

value - The data to add.

add

public void add(int value)

Adds a data value.

Parameters:

value - The data to add.

add

public void add(long value)

Adds a data value.

Parameters:

value - The data to add.

add

public void add(double value)

Adds a data value.

Parameters:

value - The data to add.

add

public void add(String value)

Adds a data value.

Parameters:

value - The data to add.

set

public void set(int index,
                SoyData value)

Sets a data value at a given index.

Parameters:

index - The index.

value - The data to set.

set

public void set(int index,
                boolean value)

Sets a data value at a given index.

Parameters:

index - The index.

value - The data to set.

set

public void set(int index,
                int value)

Sets a data value at a given index.

Parameters:

index - The index.

value - The data to set.

set

public void set(int index,
                double value)

Sets a data value at a given index.

Parameters:

index - The index.

value - The data to set.

set

public void set(int index,
                String value)

Sets a data value at a given index.

Parameters:

index - The index.

value - The data to set.

remove

public void remove(int index)

Removes the data value at a given index.

Parameters:

index - The index.

get

public SoyData get(int index)

Gets the data value at a given index.

Specified by:

get in interface SoyList

Parameters:

index - The index.

Returns:

The data at the given index, or null of the index is undefined.

getMapData

public SoyMapData getMapData(int index)

Precondition: The specified index contains a SoyMapData object. Gets the SoyMapData at the given index.

Parameters:

index - The index.

Returns:

The SoyMapData at the given index, or null of the index is undefined.

getListData

public SoyListData getListData(int index)

Precondition: The specified index contains a SoyListData object. Gets the SoyListData at the given index.

Parameters:

index - The index.

Returns:

The SoyListData at the given index, or null of the index is undefined.

getBoolean

public boolean getBoolean(int index)

Precondition: The specified index contains a boolean. Gets the boolean at the given index.

Parameters:

index - The index.

Returns:

The boolean at the given index, or null of the index is undefined.

getInteger

public int getInteger(int index)

Precondition: The specified index contains an integer. Gets the integer at the given index.

Parameters:

index - The index.

Returns:

The integer at the given index, or null of the index is undefined.

getLong

public long getLong(int index)

Precondition: The specified index contains a long. Gets the long at the given index.

Parameters:

index - The index.

Returns:

The long at the given index, or null of the index is undefined.

getFloat

public double getFloat(int index)

Precondition: The specified index contains a float. Gets the float at the given index.

Parameters:

index - The index.

Returns:

The float at the given index, or null of the index is undefined.

getString

public String getString(int index)

Precondition: The specified index contains a string. Gets the string at the given index.

Parameters:

index - The index.

Returns:

The string at the given index, or null of the index is undefined.

putSingle

public void putSingle(String key,
                      SoyData value)

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

Puts data into this data object at the specified key.

Specified by:

putSingle in class CollectionData

Parameters:

key - An individual key.

value - The data to put at the specified key.

removeSingle

public void removeSingle(String key)

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

Removes the data at the specified key.

Specified by:

removeSingle in class CollectionData

Parameters:

key - An individual key.

getSingle

public SoyData getSingle(String key)

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

Gets the data at the specified key.

Specified by:

getSingle in class CollectionData

Parameters:

key - An individual key.

Returns:

The data at the specified key, or null if the key is not defined.

asJavaList

@Nonnull
public 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 List<? extends 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.

getProvider

public 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 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 Iterable<? extends SoyValue> 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 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 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 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.