com.google.appinventor.components.runtime.util

Class YailList

java.lang.Object

com.google.appinventor.components.runtime.util.YailList

public class YailList
extends java.lang.Object

YailList is the main list primitive used by App Inventor components. This class was changed to eliminate the need for kawa library. However, the class name did not change so that no refactoring had to be done.

Constructor Summary

Constructors

Constructor and Description
YailList() Create an empty YailList; ArrayList

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(java.lang.String anItem) Appends an item to the end of the list
java.lang.String	getItem(int index) Returns the element at the specified position in this list.t
java.util.ArrayList<java.lang.String>	getItems() Returns all items in the YailList; ArrayList
java.lang.Object	getObject(int index) Return the Object at the given index.
java.lang.String	getString(int index) Return the String at the given index.
boolean	isListEmpty() Checks to see if the list is empty or not
static YailList	makeEmptyList() Create an empty YailList YailList from an array.
static YailList	makeList(java.util.Collection vals) Create a YailList from a Collection.
static YailList	makeList(java.util.List vals) Create a YailList from a List.
static YailList	makeList(java.lang.Object[] objects) Create a YailList from an array.
static YailList	makeList(java.lang.Object[] objects, int sortOrder) Create a YailList from an array.
void	removeItem(int index) Removes the item at specified index from the list
void	removeItem(java.lang.String item)
void	replaceValue(int position, java.lang.String newValue) This method replaces value at specified position with the newValue
void	setItems(java.util.ArrayList<java.lang.String> items)
int	size() Return the size of this list.
java.lang.Object[]	toArray() Return this YailList as an array.
java.lang.String	toJSONString() Return a strictly syntactically correct JSON text representation of this YailList.
java.lang.String	toString() Return a String representation of this list.
java.lang.String[]	toStringArray() Return this YailList as an array of Strings.
static java.lang.String	YailListElementToString(java.lang.Object element) Convert a YailList element to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

YailList

public YailList()

Create an empty YailList; ArrayList

Method Detail

makeEmptyList

public static YailList makeEmptyList()

Create an empty YailList YailList from an array.

makeList

public static YailList makeList(java.lang.Object[] objects)

Create a YailList from an array.

replaceValue

public void replaceValue(int position,
                java.lang.String newValue)

This method replaces value at specified position with the newValue

Parameters:

position - replaces item at specified position with a new item

newValue -

makeList

public static YailList makeList(java.lang.Object[] objects,
                int sortOrder)

Create a YailList from an array. Items will be sorted based on sortOrder. If 0 or invalid value, then no sorting will be performed. Note: Currently only Strings are supported

Parameters:

objects - Array of String

sortOrder - indicates sort order where:

• 0 = no sort,
• 1 = Ascending
• 2 = Descending

Returns:

addItem

public void addItem(java.lang.String anItem)

Appends an item to the end of the list

Parameters:

anItem - String to append to the list

makeList

public static YailList makeList(java.util.List vals)

Create a YailList from a List.

makeList

public static YailList makeList(java.util.Collection vals)

Create a YailList from a Collection. NOTE: Only Strings types will be added; other types will be ignored

Parameters:

vals -

toArray

public java.lang.Object[] toArray()

Return this YailList as an array.

Returns:

toStringArray

public java.lang.String[] toStringArray()

Return this YailList as an array of Strings.

Returns:

YailListElementToString

public static java.lang.String YailListElementToString(java.lang.Object element)

Convert a YailList element to a string. This is the same as toString except in the case of numbers, which we convert to strings using YailNumberToString for consistency with the other places where we convert Yail numbers for printing.

Parameters:

element -

Returns:

the string

toJSONString

public java.lang.String toJSONString()

Return a strictly syntactically correct JSON text representation of this YailList. Only supports String, Number, Boolean, YailList, FString and arrays containing these types.

Returns:

size

public int size()

Return the size of this list.

Returns:

size of the list

toString

public java.lang.String toString()

Return a String representation of this list.

Overrides:

toString in class java.lang.Object

getString

public java.lang.String getString(int index)

Return the String at the given index.

Parameters:

index - Returns the item at specified location

getObject

public java.lang.Object getObject(int index)

Return the Object at the given index.

getItems

public java.util.ArrayList<java.lang.String> getItems()

Returns all items in the YailList; ArrayList

Returns:

all items in the list

getItem

public java.lang.String getItem(int index)

Returns the element at the specified position in this list.t

Parameters:

index - inedx of item; starts from 0

Returns:

the element at the specified position in this list. returns error-msg if index is out of range (index < 0 || index >= size())

setItems

public void setItems(java.util.ArrayList<java.lang.String> items)

removeItem

public void removeItem(int index)

Removes the item at specified index from the list

Parameters:

index - index of the item to remove

removeItem

public void removeItem(java.lang.String item)

isListEmpty

public boolean isListEmpty()

Checks to see if the list is empty or not

Returns:

true if list is empty, else false