ForwardingList (Guava: Google Core Libraries for Java

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.common.collect
Class ForwardingList<E>

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingCollection<E>
          com.google.common.collect.ForwardingList<E>

All Implemented Interfaces:: Iterable<E>, Collection<E>, List<E>

@GwtCompatible public abstract class ForwardingList<E>
extends ForwardingCollection<E>
implements List<E>
extends ForwardingCollection<E>
implements List<E>

A list which forwards all its method calls to another list. Subclasses should override one or more methods to modify the behavior of the backing list as desired per the decorator pattern.

This class does not implement RandomAccess. If the delegate supports random access, the ForwardingList subclass should implement the RandomAccess interface.

Warning: The methods of ForwardingList forward indiscriminately to the methods of the delegate. For example, overriding add(int, E) alone will not change the behavior of addAll(int, java.util.Collection), which can lead to unexpected behavior. In this case, you should override addAll as well, either providing your own implementation, or delegating to the provided standardAddAll method.

The standard methods and any collection views they return are not guaranteed to be thread-safe, even when all of the methods that they depend on are thread-safe.

Since:: 2 (imported from Google Collections Library)
Author:: Mike Bostock, Louis Wasserman

Constructor Summary
`protected`	`ForwardingList()` Constructor for use by subclasses.

Method Summary
`void`	`add(int index, E element)` Inserts the specified element at the specified position in this list (optional operation).
`boolean`	`addAll(int index, Collection<? extends E> elements)` Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
`protected abstract List<E>`	`delegate()` Returns the backing delegate instance that methods are forwarded to.
`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`E`	`get(int index)` Returns the element at the specified position in this list.
`int`	`hashCode()` Returns a hash code value for the object.
`int`	`indexOf(Object element)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`int`	`lastIndexOf(Object element)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`ListIterator<E>`	`listIterator()` Returns a list iterator over the elements in this list (in proper sequence).
`ListIterator<E>`	`listIterator(int index)` Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
`E`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`E`	`set(int index, E element)` Replaces the element at the specified position in this list with the specified element (optional operation).
`protected boolean`	`standardAdd(E element)` A sensible default implementation of `ForwardingCollection.add(Object)`, in terms of `add(int, Object)`.
`protected boolean`	`standardAddAll(int index, Iterable<? extends E> elements)` A sensible default implementation of `addAll(int, Collection)`, in terms of the `add` method of `listIterator(int)`.
`protected boolean`	`standardEquals(Object object)` A sensible definition of `equals(Object)` in terms of `ForwardingCollection.size()` and `ForwardingCollection.iterator()`.
`protected int`	`standardHashCode()` A sensible definition of `hashCode()` in terms of `ForwardingCollection.iterator()`.
`protected int`	`standardIndexOf(Object element)` A sensible default implementation of `indexOf(java.lang.Object)`, in terms of `listIterator()`.
`protected Iterator<E>`	`standardIterator()` A sensible default implementation of `ForwardingCollection.iterator()`, in terms of `listIterator()`.
`protected int`	`standardLastIndexOf(Object element)` A sensible default implementation of `lastIndexOf(java.lang.Object)`, in terms of `listIterator(int)`.
`protected ListIterator<E>`	`standardListIterator()` A sensible default implementation of `listIterator()`, in terms of `listIterator(int)`.
`protected ListIterator<E>`	`standardListIterator(int start)` A sensible default implementation of `listIterator(int)`, in terms of `ForwardingCollection.size()` and `get(int)`.
`protected List<E>`	`standardSubList(int fromIndex, int toIndex)` A sensible default implementation of `subList(int, int)`.
`List<E>`	`subList(int fromIndex, int toIndex)` Returns a view of the portion of this list between the specified `fromIndex`, inclusive, and `toIndex`, exclusive.

Methods inherited from class com.google.common.collect.ForwardingCollection
`add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray`

Methods inherited from class com.google.common.collect.ForwardingObject
`toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface java.util.List
`add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray`

Constructor Detail

ForwardingList

protected ForwardingList()

Constructor for use by subclasses.

Method Detail

delegate

protected abstract List<E> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:: delegate in class ForwardingCollection<E>