|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.google.common.collect.ForwardingObject com.google.common.collect.ForwardingCollection<E> com.google.common.collect.ForwardingList<E>
public abstract class ForwardingList<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.
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). |
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, 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 |
---|
protected ForwardingList()
Method Detail |
---|
protected abstract List<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.
delegate
in class ForwardingCollection<E>
public void add(int index, E element)
java.util.List
add
in interface List<E>
index
- index at which the specified element is to be insertedelement
- element to be insertedpublic boolean addAll(int index, Collection<? extends E> elements)
java.util.List
addAll
in interface List<E>
index
- index at which to insert the first element from the
specified collectionelements
- collection containing elements to be added to this list
public E get(int index)
java.util.List
get
in interface List<E>
index
- index of the element to return
public int indexOf(Object element)
java.util.List
indexOf
in interface List<E>
element
- element to search for
public int lastIndexOf(Object element)
java.util.List
lastIndexOf
in interface List<E>
element
- element to search for
public ListIterator<E> listIterator()
java.util.List
listIterator
in interface List<E>
public ListIterator<E> listIterator(int index)
java.util.List
next
.
An initial call to previous
would
return the element with the specified index minus one.
listIterator
in interface List<E>
index
- index of the first element to be returned from the
list iterator (by a call to next
)
public E remove(int index)
java.util.List
remove
in interface List<E>
index
- the index of the element to be removed
public E set(int index, E element)
java.util.List
set
in interface List<E>
index
- index of the element to replaceelement
- element to be stored at the specified position
public List<E> subList(int fromIndex, int toIndex)
java.util.List
This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:
list.subList(from, to).clear();Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.
The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)
subList
in interface List<E>
fromIndex
- low endpoint (inclusive) of the subListtoIndex
- high endpoint (exclusive) of the subList
public boolean equals(@Nullable Object object)
java.lang.Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in interface Collection<E>
equals
in interface List<E>
equals
in class Object
object
- the reference object with which to compare.
true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
java.lang.Object
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
hashCode
in interface Collection<E>
hashCode
in interface List<E>
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |