bibliothek.gui.dock.station.support

Interface PlaceholderList.Filter<M>

Type Parameters:

M - the kind of data this filter offers

All Superinterfaces:

Iterable<M>

Enclosing class:

PlaceholderList<D,S,P extends PlaceholderListItem<D>>

public static interface PlaceholderList.Filter<M>
extends Iterable<M>

A sublist of a PlaceholderList, the elements in this list are filtered by a strategy that is defined by the PlaceholderList. Modifying this list has an effect in the enclosing PlaceholderList.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	add(int index, M object) Inserts object at location index of this list.
void	add(M object) Adds object to this list, the object is added at the end of the list.
void	addPlaceholder(int index, Path placeholder) Adds a placeholder at location index, ensures that this placeholder is only present at index.
M	get(int index) Gets the index'th element of this list.
PlaceholderMetaMap	getMetaMap(int index) Gets a mutable map which is associated with the index'th entry, the content of this map is stored persistently.
int	indexOf(M object) Searches the first occurrence of object.
int	indexOfPlaceholder(Path placeholder) Searches the first occurence of placeholder.
void	insertPlaceholder(int index, Path placeholder) Generates a new entry containing only placeholder.
void	move(int source, int destination) Moves the item at location source to location destination.
void	move(PlaceholderList.Filter<M> sourceList, int sourceIndex, int destination) Moves an item from sourceList to this list.
M	remove(int index) Removes the object at location index from this list.
int	remove(M object) Removes the first occurrence of object.
M	set(int index, M object) Replaces the object at location index by object.
int	size() The number of elements that are in this list

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

size

int size()

The number of elements that are in this list

Returns:

the length

get

M get(int index)

Gets the index'th element of this list.

Parameters:

index - the location of some element

Returns:

the element, not null

getMetaMap

PlaceholderMetaMap getMetaMap(int index)

Gets a mutable map which is associated with the index'th entry, the content of this map is stored persistently.

Parameters:

index - the location of some element

Returns:

the map associated with that element

add

void add(M object)

Adds object to this list, the object is added at the end of the list.

Parameters:

object - the new object, not null

add

void add(int index,
         M object)

Inserts object at location index of this list.

Parameters:

index - the location

object - the new element, not null

addPlaceholder

void addPlaceholder(int index,
                    Path placeholder)

Adds a placeholder at location index, ensures that this placeholder is only present at index.

Parameters:

index - some location

placeholder - the placeholder to insert

insertPlaceholder

void insertPlaceholder(int index,
                       Path placeholder)

Generates a new entry containing only placeholder. Filters not able to show entries with only placeholders will still insert the entry, but the client cannot access it.

Parameters:

index - the location of the new entry

placeholder - the content of the new entry

set

M set(int index,
      M object)

Replaces the object at location index by object.

Parameters:

index - the location

object - the new element, not null

Returns:

the old object at that place

remove

M remove(int index)

Removes the object at location index from this list.

Parameters:

index - the location of some object

Returns:

the object that was removed, not null

remove

int remove(M object)

Removes the first occurrence of object. This method searches with help of the Object.equals(Object) method.

Parameters:

object - the object to remove, not null

Returns:

the index of the removed object or -1 if it was not found

indexOf

int indexOf(M object)

Searches the first occurrence of object.

Parameters:

object - the object to search, not null

Returns:

the location or -1 if the object was not found

indexOfPlaceholder

int indexOfPlaceholder(Path placeholder)

Searches the first occurence of placeholder.

Parameters:

placeholder - the placeholder to search

Returns:

the location of placeholder or -1

move

void move(int source,
          int destination)

Moves the item at location source to location destination.

Parameters:

source - the current location of some item

destination - the new location

move

void move(PlaceholderList.Filter<M> sourceList,
          int sourceIndex,
          int destination)

Moves an item from sourceList to this list.

• If sourceList is this, then calling this method is equivalent of calling move(int, int).
• If sourceList is an inner object from the same PlaceholderList, then calling move(int, int) of PlaceholderList.list() with adapted arguments is equivalent of calling this method.
• Otherwise the item will be removed from the sourceList, and a copy will be inserted into this list.

This method has to assume that sourceList is of the same type as this. This is true for all PlaceholderList.Filters that were created by a PlaceholderList, but if clients implement the interface then this method will throw an IllegalArgumentException

Parameters:

sourceList - the list to read from

sourceIndex - the current location of some item

destination - the new location

Throws:

IllegalArgumentException - if sourceList is of a type that is not recognized by this class, or if any of sourceIndex of destination is invalid