PrefixIndexListDecorator (InstaTrie 1.5 API)

Type Parameters:

T - list entry type

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>, PrefixIndex<T>, Serializable

All Known Implementing Classes:

TriePrefixIndex.TriePrefixIndexListDecorator, TriePrefixIndex.TriePrefixIndexListDecoratorFiltered
```
public interface PrefixIndexListDecorator<T extends Serializable>
extends List<T>, PrefixIndex<T>
```
Decorator for prefix index to enable the List interface. Delegate implementation is done with interface default methods.

Author:

Christian Simon

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`add(int index, T element)`
`default boolean`	`add(T e)`
`default boolean`	`addAll(Collection<? extends T> c)`
`default boolean`	`addAll(int index, Collection<? extends T> c)`
`default void`	`clear()`
`default boolean`	`contains(Object o)`
`default boolean`	`containsAll(Collection<?> c)`
`default T`	`get(int index)`
`PrefixIndexListDecorator<T>`	`getFilteredView(Predicate<T> filterFunction)` Get a view on the current prefix index which only returns models matching the given filter predicate.
`default int`	`indexOf(Object o)`
`default boolean`	`isEmpty()`
`default Iterator<T>`	`iterator()`
`default int`	`lastIndexOf(Object o)`
`default ListIterator<T>`	`listIterator()`
`default ListIterator<T>`	`listIterator(int index)`
`default T`	`remove(int index)`
`default boolean`	`remove(Object o)`
`default boolean`	`removeAll(Collection<?> c)`
`default boolean`	`retainAll(Collection<?> c)`
`default T`	`set(int index, T element)`
`default int`	`size()`
`default List<T>`	`subList(int fromIndex, int toIndex)`
`default Object[]`	`toArray()`
`default <S> S[]`	`toArray(S[] a)`

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface com.illucit.instatrie.index.PrefixIndex
createIndex, decorateAsList, getAll, getHighlighted, getHighlightedHtml, search, search, searchExact, searchStream

- Method Detail
  - size
```
default int size()
```
    Specified by:
    
    size in interface Collection<T extends Serializable>
    
    Specified by:
    
    size in interface List<T extends Serializable>
  - isEmpty
```
default boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T extends Serializable>
    
    Specified by:
    
    isEmpty in interface List<T extends Serializable>
  - contains
```
default boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<T extends Serializable>
    
    Specified by:
    
    contains in interface List<T extends Serializable>
  - iterator
```
default Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Collection<T extends Serializable>
    
    Specified by:
    
    iterator in interface Iterable<T extends Serializable>
    
    Specified by:
    
    iterator in interface List<T extends Serializable>
  - toArray
```
default Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T extends Serializable>
    
    Specified by:
    
    toArray in interface List<T extends Serializable>
  - toArray
```
default <S> S[] toArray(S[] a)
```
    Specified by:
    
    toArray in interface Collection<T extends Serializable>
    
    Specified by:
    
    toArray in interface List<T extends Serializable>
  - add
```
default boolean add(T e)
```
    Specified by:
    
    add in interface Collection<T extends Serializable>
    
    Specified by:
    
    add in interface List<T extends Serializable>
  - remove
```
default boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<T extends Serializable>
    
    Specified by:
    
    remove in interface List<T extends Serializable>
  - containsAll
```
default boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<T extends Serializable>
    
    Specified by:
    
    containsAll in interface List<T extends Serializable>
  - addAll
```
default boolean addAll(Collection<? extends T> c)
```
    Specified by:
    
    addAll in interface Collection<T extends Serializable>
    
    Specified by:
    
    addAll in interface List<T extends Serializable>
  - addAll
```
default boolean addAll(int index,
                       Collection<? extends T> c)
```
    Specified by:
    
    addAll in interface List<T extends Serializable>
  - removeAll
```
default boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<T extends Serializable>
    
    Specified by:
    
    removeAll in interface List<T extends Serializable>
  - retainAll
```
default boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<T extends Serializable>
    
    Specified by:
    
    retainAll in interface List<T extends Serializable>
  - clear
```
default void clear()
```
    Specified by:
    
    clear in interface Collection<T extends Serializable>
    
    Specified by:
    
    clear in interface List<T extends Serializable>
  - get
```
default T get(int index)
```
    Specified by:
    
    get in interface List<T extends Serializable>
  - set
```
default T set(int index,
              T element)
```
    Specified by:
    
    set in interface List<T extends Serializable>
  - add
```
default void add(int index,
                 T element)
```
    Specified by:
    
    add in interface List<T extends Serializable>
  - remove
```
default T remove(int index)
```
    Specified by:
    
    remove in interface List<T extends Serializable>
  - indexOf
```
default int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<T extends Serializable>
  - lastIndexOf
```
default int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<T extends Serializable>
  - listIterator
```
default ListIterator<T> listIterator()
```
    Specified by:
    
    listIterator in interface List<T extends Serializable>
  - listIterator
```
default ListIterator<T> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<T extends Serializable>
  - subList
```
default List<T> subList(int fromIndex,
                        int toIndex)
```
    Specified by:
    
    subList in interface List<T extends Serializable>
  - getFilteredView
```
PrefixIndexListDecorator<T> getFilteredView(Predicate<T> filterFunction)
```
    Description copied from interface: PrefixIndex
    
    Get a view on the current prefix index which only returns models matching the given filter predicate. The returned instance is completely entangled with the current object, so that both objects share a state and each trie operation on one of the objects also affects the other object in the same way. The original prefix index won't be modified by this operation. If the current instance already contins a filter, the new predicate will be added as additional filter predicate.
    
    Specified by:
    
    getFilteredView in interface PrefixIndex<T extends Serializable>
    
    Parameters:
    
    filterFunction - filter function to filter search stream
    
    Returns:
    
    decorated prefix index

Interface PrefixIndexListDecorator<T extends Serializable>

Method Summary

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.illucit.instatrie.index.PrefixIndex

Method Detail

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList

getFilteredView