io.realm.dynamic

Class DynamicRealmList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<DynamicRealmObject>

io.realm.dynamic.DynamicRealmList

All Implemented Interfaces:

java.lang.Iterable<DynamicRealmObject>, java.util.Collection<DynamicRealmObject>, java.util.List<DynamicRealmObject>

public class DynamicRealmList
extends java.util.AbstractList<DynamicRealmObject>

RealmList exposed using a dynamic API. All objects in the list must have the same schema even though they are accessed dynamically. Null values are not allowed in this list.

Method Summary

Modifier and Type	Method and Description
boolean	add(DynamicRealmObject object) Adds the specified object at the end of this List.
void	clear() Removes all elements from this list, leaving it empty.
DynamicRealmObject	get(int location) Returns the element at the specified location in this list.
DynamicRealmObject	remove(int location) Removes the object at the specified location from this list.
DynamicRealmObject	set(int location, DynamicRealmObject object) Replaces the element at the specified location in this list with the specified object.
int	size() Returns the number of elements in this list.

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

add

public boolean add(DynamicRealmObject object)

Adds the specified object at the end of this List.

Specified by:

add in interface java.util.Collection<DynamicRealmObject>

Specified by:

add in interface java.util.List<DynamicRealmObject>

Overrides:

add in class java.util.AbstractList<DynamicRealmObject>

Parameters:

object - the object to add.

Returns:

always true.

Throws:

java.lang.IllegalArgumentException - if object is either null or has the wrong type.

clear

public void clear()

Removes all elements from this list, leaving it empty.

Specified by:

clear in interface java.util.Collection<DynamicRealmObject>

Specified by:

clear in interface java.util.List<DynamicRealmObject>

Overrides:

clear in class java.util.AbstractList<DynamicRealmObject>

See Also:

List.isEmpty(), List.size()

get

public DynamicRealmObject get(int location)

Returns the element at the specified location in this list.

Specified by:

get in interface java.util.List<DynamicRealmObject>

Specified by:

get in class java.util.AbstractList<DynamicRealmObject>

Parameters:

location - the index of the element to return.

Returns:

the element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - if location < 0 || location >= size().

remove

public DynamicRealmObject remove(int location)

Removes the object at the specified location from this list.

Specified by:

remove in interface java.util.List<DynamicRealmObject>

Overrides:

remove in class java.util.AbstractList<DynamicRealmObject>

Parameters:

location - the index of the object to remove.

Returns:

the removed object.

Throws:

java.lang.IndexOutOfBoundsException - if location < 0 || location >= size().

set

public DynamicRealmObject set(int location,
                              DynamicRealmObject object)

Replaces the element at the specified location in this list with the specified object.

Specified by:

set in interface java.util.List<DynamicRealmObject>

Overrides:

set in class java.util.AbstractList<DynamicRealmObject>

Parameters:

location - the index at which to put the specified object.

object - the object to add.

Returns:

the previous element at the index.

Throws:

java.lang.IllegalArgumentException - if object is either null or has the wrong type.

java.lang.IndexOutOfBoundsException - if location < 0 || location >= size().

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface java.util.Collection<DynamicRealmObject>

Specified by:

size in interface java.util.List<DynamicRealmObject>

Specified by:

size in class java.util.AbstractCollection<DynamicRealmObject>

Returns:

the number of elements in this list.