Package com.esri.arcgisruntime.mapping

Class BookmarkList

java.lang.Object

com.esri.arcgisruntime.mapping.BookmarkList

All Implemented Interfaces:

ListenableList<Bookmark>, Iterable<Bookmark>, Collection<Bookmark>, List<Bookmark>

public final class BookmarkList
extends Object
implements ListenableList<Bookmark>

Represents the bookmarks of an ArcGISMap.

This class is not creatable but bookmarks can be added and removed. Changes to the list can be observed by adding a ListChangedListener.

Since:

100.0.0

See Also:

ListenableList, ListChangedListener, Bookmark, GeoModel.getBookmarks()

Method Summary

Modifier and Type	Method	Description
void	add(int index, Bookmark bookmark)
boolean	add(Bookmark bookmark)
boolean	addAll(int index, Collection<? extends Bookmark> collection)
boolean	addAll(Collection<? extends Bookmark> collection)
void	addListChangedListener(ListChangedListener<Bookmark> listener)	Adds a listener for added and removed events.
void	clear()
boolean	contains(Object object)
boolean	containsAll(Collection<?> collection)
Bookmark	get(int index)
int	indexOf(Object object)
boolean	isEmpty()
Iterator<Bookmark>	iterator()
int	lastIndexOf(Object object)
ListIterator<Bookmark>	listIterator()
ListIterator<Bookmark>	listIterator(int index)
Bookmark	remove(int index)
boolean	remove(Object object)
boolean	removeAll(Collection<?> collection)
boolean	removeListChangedListener(ListChangedListener<Bookmark> listener)	Removes the given listener from this class instance.
boolean	retainAll(Collection<?> collection)
Bookmark	set(int index, Bookmark bookmark)
int	size()
List<Bookmark>	subList(int start, int end)
Object[]	toArray()
<T> T[]	toArray(T[] array)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Method Detail

add

public void add(int index,
                Bookmark bookmark)

Specified by:

add in interface List<Bookmark>

add

public boolean add(Bookmark bookmark)

Specified by:

add in interface Collection<Bookmark>

Specified by:

add in interface List<Bookmark>

addAll

public boolean addAll(int index,
                      Collection<? extends Bookmark> collection)

Specified by:

addAll in interface List<Bookmark>

addAll

public boolean addAll(Collection<? extends Bookmark> collection)

Specified by:

addAll in interface Collection<Bookmark>

Specified by:

addAll in interface List<Bookmark>

clear

public void clear()

Specified by:

clear in interface Collection<Bookmark>

Specified by:

clear in interface List<Bookmark>

contains

public boolean contains(Object object)

Specified by:

contains in interface Collection<Bookmark>

Specified by:

contains in interface List<Bookmark>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<Bookmark>

Specified by:

containsAll in interface List<Bookmark>

get

public Bookmark get(int index)

Specified by:

get in interface List<Bookmark>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface List<Bookmark>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Bookmark>

Specified by:

isEmpty in interface List<Bookmark>

iterator

public Iterator<Bookmark> iterator()

Specified by:

iterator in interface Collection<Bookmark>

Specified by:

iterator in interface Iterable<Bookmark>

Specified by:

iterator in interface List<Bookmark>

lastIndexOf

public int lastIndexOf(Object object)

Specified by:

lastIndexOf in interface List<Bookmark>

listIterator

public ListIterator<Bookmark> listIterator()

Specified by:

listIterator in interface List<Bookmark>

listIterator

public ListIterator<Bookmark> listIterator(int index)

Specified by:

listIterator in interface List<Bookmark>

remove

public Bookmark remove(int index)

Specified by:

remove in interface List<Bookmark>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<Bookmark>

Specified by:

remove in interface List<Bookmark>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<Bookmark>

Specified by:

removeAll in interface List<Bookmark>

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<Bookmark>

Specified by:

retainAll in interface List<Bookmark>

set

public Bookmark set(int index,
                    Bookmark bookmark)

Specified by:

set in interface List<Bookmark>

size

public int size()

Specified by:

size in interface Collection<Bookmark>

Specified by:

size in interface List<Bookmark>

subList

public List<Bookmark> subList(int start,
                              int end)

Specified by:

subList in interface List<Bookmark>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Bookmark>

Specified by:

toArray in interface List<Bookmark>

toArray

public <T> T[] toArray(T[] array)

Specified by:

toArray in interface Collection<Bookmark>

Specified by:

toArray in interface List<Bookmark>

addListChangedListener

public void addListChangedListener(ListChangedListener<Bookmark> listener)

Description copied from interface: ListenableList

Adds a listener for added and removed events.

Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

Specified by:

addListChangedListener in interface ListenableList<Bookmark>

Parameters:

listener - this listener will be called back when items are added to or removed from the list

removeListChangedListener

public boolean removeListChangedListener(ListChangedListener<Bookmark> listener)

Description copied from interface: ListenableList

Removes the given listener from this class instance. It will no longer receive added or removed events.

Specified by:

removeListChangedListener in interface ListenableList<Bookmark>

Parameters:

listener - listener to remove

Returns:

true if the listenable list contained the given listener, false otherwise