a whole bunch of stuff
[ephemerata.git] / KezvhLib / lib / com.google.com.collect / javadoc / com / google / common / collect / ForwardingList.html
blob02b3daab8a3a38913a4e9d0939f36953c89dd190
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.5.0_06) on Wed Aug 20 17:16:44 PDT 2008 -->
6 <TITLE>
7 ForwardingList (Google Collections Library - snapshot-20080820 (ALPHA))
8 </TITLE>
10 <META NAME="keywords" CONTENT="com.google.common.collect.ForwardingList class">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 parent.document.title="ForwardingList (Google Collections Library - snapshot-20080820 (ALPHA))";
19 </SCRIPT>
20 <NOSCRIPT>
21 </NOSCRIPT>
23 </HEAD>
25 <BODY BGCOLOR="white" onload="windowTitle();">
28 <!-- ========= START OF TOP NAVBAR ======= -->
29 <A NAME="navbar_top"><!-- --></A>
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32 <TR>
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34 <A NAME="navbar_top_firstrow"><!-- --></A>
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45 </TABLE>
46 </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48 </EM>
49 </TD>
50 </TR>
52 <TR>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingListIterator.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../index.html?com/google/common/collect/ForwardingList.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="ForwardingList.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59 &nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
64 //-->
65 </SCRIPT>
66 <NOSCRIPT>
67 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68 </NOSCRIPT>
71 </FONT></TD>
72 </TR>
73 <TR>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78 </TR>
79 </TABLE>
80 <A NAME="skip-navbar_top"></A>
81 <!-- ========= END OF TOP NAVBAR ========= -->
83 <HR>
84 <!-- ======== START OF CLASS DATA ======== -->
85 <H2>
86 <FONT SIZE="-1">
87 com.google.common.collect</FONT>
88 <BR>
89 Class ForwardingList&lt;E&gt;</H2>
90 <PRE>
91 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingObject</A>
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingCollection</A>&lt;E&gt;
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ForwardingList&lt;E&gt;</B>
95 </PRE>
96 <DL>
97 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;E&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;E&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;E&gt;</DD>
98 </DL>
99 <HR>
100 <DL>
101 <DT><PRE>public abstract class <B>ForwardingList&lt;E&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A>&lt;E&gt;<DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;E&gt;</DL>
102 </PRE>
105 A list which forwards all its method calls to another list. Subclasses should
106 override one or more methods to modify the behavior of the backing list as
107 desired per the <a
108 href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
110 <p>This class does not implement <A HREF="http://java.sun.com/javase/6/docs/api/java/util/RandomAccess.html" title="class or interface in java.util"><CODE>RandomAccess</CODE></A>. If the
111 delegate supports random access, the <code>ForwadingList</code> subclass should
112 implement the <code>RandomAccess</code> interface.
116 <DL>
117 <DT><B>Author:</B></DT>
118 <DD>Mike Bostock</DD>
119 </DL>
120 <HR>
124 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
126 <A NAME="constructor_summary"><!-- --></A>
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
130 <B>Constructor Summary</B></FONT></TH>
131 </TR>
132 <TR BGCOLOR="white" CLASS="TableRowColor">
133 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#ForwardingList()">ForwardingList</A></B>()</CODE>
135 <BR>
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
137 </TR>
138 </TABLE>
139 &nbsp;
140 <!-- ========== METHOD SUMMARY =========== -->
142 <A NAME="method_summary"><!-- --></A>
143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146 <B>Method Summary</B></FONT></TH>
147 </TR>
148 <TR BGCOLOR="white" CLASS="TableRowColor">
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150 <CODE>&nbsp;void</CODE></FONT></TD>
151 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#add(int, E)">add</A></B>(int&nbsp;index,
152 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&nbsp;element)</CODE>
154 <BR>
155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the specified element at the specified position in this list
156 (optional operation).</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;boolean</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#addAll(int, java.util.Collection)">addAll</A></B>(int&nbsp;index,
162 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;? extends <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;&nbsp;elements)</CODE>
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts all of the elements in the specified collection into this
166 list at the specified position (optional operation).</TD>
167 </TR>
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170 <CODE>protected abstract &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></FONT></TD>
171 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#delegate()">delegate</A></B>()</CODE>
173 <BR>
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backing delegate instance that methods are forwarded to.</TD>
175 </TR>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178 <CODE>&nbsp;boolean</CODE></FONT></TD>
179 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>
181 <BR>
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether some other object is "equal to" this one.</TD>
183 </TR>
184 <TR BGCOLOR="white" CLASS="TableRowColor">
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A></CODE></FONT></TD>
187 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#get(int)">get</A></B>(int&nbsp;index)</CODE>
189 <BR>
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the element at the specified position in this list.</TD>
191 </TR>
192 <TR BGCOLOR="white" CLASS="TableRowColor">
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194 <CODE>&nbsp;int</CODE></FONT></TD>
195 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#hashCode()">hashCode</A></B>()</CODE>
197 <BR>
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash code value for the object.</TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202 <CODE>&nbsp;int</CODE></FONT></TD>
203 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#indexOf(java.lang.Object)">indexOf</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
205 <BR>
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index in this list of the first occurrence of the specified
207 element, or -1 if this list does not contain this element.</TD>
208 </TR>
209 <TR BGCOLOR="white" CLASS="TableRowColor">
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211 <CODE>&nbsp;int</CODE></FONT></TD>
212 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#lastIndexOf(java.lang.Object)">lastIndexOf</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
214 <BR>
215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index in this list of the last occurrence of the specified
216 element, or -1 if this list does not contain this element.</TD>
217 </TR>
218 <TR BGCOLOR="white" CLASS="TableRowColor">
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/ListIterator.html" title="class or interface in java.util">ListIterator</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></FONT></TD>
221 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#listIterator()">listIterator</A></B>()</CODE>
223 <BR>
224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list iterator of the elements in this list (in proper
225 sequence).</TD>
226 </TR>
227 <TR BGCOLOR="white" CLASS="TableRowColor">
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/ListIterator.html" title="class or interface in java.util">ListIterator</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></FONT></TD>
230 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#listIterator(int)">listIterator</A></B>(int&nbsp;index)</CODE>
232 <BR>
233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list iterator of the elements in this list (in proper
234 sequence), starting at the specified position in this list.</TD>
235 </TR>
236 <TR BGCOLOR="white" CLASS="TableRowColor">
237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A></CODE></FONT></TD>
239 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#remove(int)">remove</A></B>(int&nbsp;index)</CODE>
241 <BR>
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the element at the specified position in this list (optional
243 operation).</TD>
244 </TR>
245 <TR BGCOLOR="white" CLASS="TableRowColor">
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A></CODE></FONT></TD>
248 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#set(int, E)">set</A></B>(int&nbsp;index,
249 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&nbsp;element)</CODE>
251 <BR>
252 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the element at the specified position in this list with the
253 specified element (optional operation).</TD>
254 </TR>
255 <TR BGCOLOR="white" CLASS="TableRowColor">
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></FONT></TD>
258 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingList.html#subList(int, int)">subList</A></B>(int&nbsp;fromIndex,
259 int&nbsp;toIndex)</CODE>
261 <BR>
262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a view of the portion of this list between the specified
263 <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, exclusive.</TD>
264 </TR>
265 </TABLE>
266 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingCollection"><!-- --></A>
267 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
269 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A></B></TH>
270 </TR>
271 <TR BGCOLOR="white" CLASS="TableRowColor">
272 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html#add(E)">add</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#addAll(java.util.Collection)">addAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#contains(java.lang.Object)">contains</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#iterator()">iterator</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#size()">size</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#toArray()">toArray</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#toArray(T[])">toArray</A></CODE></TD>
273 </TR>
274 </TABLE>
275 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A>
276 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
278 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></B></TH>
279 </TR>
280 <TR BGCOLOR="white" CLASS="TableRowColor">
281 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD>
282 </TR>
283 </TABLE>
284 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
285 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
286 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
287 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
288 </TR>
289 <TR BGCOLOR="white" CLASS="TableRowColor">
290 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
291 </TR>
292 </TABLE>
293 &nbsp;<A NAME="methods_inherited_from_class_java.util.List"><!-- --></A>
294 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
295 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
296 <TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A></B></TH>
297 </TR>
298 <TR BGCOLOR="white" CLASS="TableRowColor">
299 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#add(E)" title="class or interface in java.util">add</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#contains(java.lang.Object)" title="class or interface in java.util">contains</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#iterator()" title="class or interface in java.util">iterator</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#remove(java.lang.Object)" title="class or interface in java.util">remove</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#size()" title="class or interface in java.util">size</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#toArray()" title="class or interface in java.util">toArray</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#toArray(T[])" title="class or interface in java.util">toArray</A></CODE></TD>
300 </TR>
301 </TABLE>
302 &nbsp;
305 <!-- ========= CONSTRUCTOR DETAIL ======== -->
307 <A NAME="constructor_detail"><!-- --></A>
308 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
309 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
310 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
311 <B>Constructor Detail</B></FONT></TH>
312 </TR>
313 </TABLE>
315 <A NAME="ForwardingList()"><!-- --></A><H3>
316 ForwardingList</H3>
317 <PRE>
318 public <B>ForwardingList</B>()</PRE>
319 <DL>
320 </DL>
322 <!-- ============ METHOD DETAIL ========== -->
324 <A NAME="method_detail"><!-- --></A>
325 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
326 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
327 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
328 <B>Method Detail</B></FONT></TH>
329 </TR>
330 </TABLE>
332 <A NAME="delegate()"><!-- --></A><H3>
333 delegate</H3>
334 <PRE>
335 protected abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt; <B>delegate</B>()</PRE>
336 <DL>
337 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD>
338 <DD>Returns the backing delegate instance that methods are forwarded to.
339 Abstract subclasses generally override the <A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A> method
340 with an abstract method that has a more specific return type, such as
341 <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to
342 supply the instance being decorated.
344 <DD><DL>
345 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
346 </DD>
347 <DD><DL>
348 </DL>
349 </DD>
350 </DL>
351 <HR>
353 <A NAME="add(int,java.lang.Object)"><!-- --></A><A NAME="add(int, E)"><!-- --></A><H3>
354 add</H3>
355 <PRE>
356 public void <B>add</B>(int&nbsp;index,
357 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&nbsp;element)</PRE>
358 <DL>
359 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#add(int, E)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
360 <DD>Inserts the specified element at the specified position in this list
361 (optional operation). Shifts the element currently at that position
362 (if any) and any subsequent elements to the right (adds one to their
363 indices).
365 <DD><DL>
366 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#add(int, E)" title="class or interface in java.util">add</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
367 </DD>
368 <DD><DL>
369 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index at which the specified element is to be inserted.<DD><CODE>element</CODE> - element to be inserted.</DL>
370 </DD>
371 </DL>
372 <HR>
374 <A NAME="addAll(int, java.util.Collection)"><!-- --></A><H3>
375 addAll</H3>
376 <PRE>
377 public boolean <B>addAll</B>(int&nbsp;index,
378 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;? extends <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;&nbsp;elements)</PRE>
379 <DL>
380 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#addAll(int, java.util.Collection)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
381 <DD>Inserts all of the elements in the specified collection into this
382 list at the specified position (optional operation). Shifts the
383 element currently at that position (if any) and any subsequent
384 elements to the right (increases their indices). The new elements
385 will appear in this list in the order that they are returned by the
386 specified collection's iterator. The behavior of this operation is
387 unspecified if the specified collection is modified while the
388 operation is in progress. (Note that this will occur if the specified
389 collection is this list, and it's nonempty.)
391 <DD><DL>
392 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#addAll(int, java.util.Collection)" title="class or interface in java.util">addAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
393 </DD>
394 <DD><DL>
395 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index at which to insert first element from the specified
396 collection.<DD><CODE>elements</CODE> - elements to be inserted into this list.
397 <DT><B>Returns:</B><DD><tt>true</tt> if this list changed as a result of the call.</DL>
398 </DD>
399 </DL>
400 <HR>
402 <A NAME="get(int)"><!-- --></A><H3>
403 get</H3>
404 <PRE>
405 public <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A> <B>get</B>(int&nbsp;index)</PRE>
406 <DL>
407 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#get(int)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
408 <DD>Returns the element at the specified position in this list.
410 <DD><DL>
411 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#get(int)" title="class or interface in java.util">get</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
412 </DD>
413 <DD><DL>
414 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index of element to return.
415 <DT><B>Returns:</B><DD>the element at the specified position in this list.</DL>
416 </DD>
417 </DL>
418 <HR>
420 <A NAME="indexOf(java.lang.Object)"><!-- --></A><H3>
421 indexOf</H3>
422 <PRE>
423 public int <B>indexOf</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
424 <DL>
425 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#indexOf(java.lang.Object)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
426 <DD>Returns the index in this list of the first occurrence of the specified
427 element, or -1 if this list does not contain this element.
428 More formally, returns the lowest index <tt>i</tt> such that
429 <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>,
430 or -1 if there is no such index.
432 <DD><DL>
433 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#indexOf(java.lang.Object)" title="class or interface in java.util">indexOf</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
434 </DD>
435 <DD><DL>
436 <DT><B>Parameters:</B><DD><CODE>element</CODE> - element to search for.
437 <DT><B>Returns:</B><DD>the index in this list of the first occurrence of the specified
438 element, or -1 if this list does not contain this element.</DL>
439 </DD>
440 </DL>
441 <HR>
443 <A NAME="lastIndexOf(java.lang.Object)"><!-- --></A><H3>
444 lastIndexOf</H3>
445 <PRE>
446 public int <B>lastIndexOf</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
447 <DL>
448 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#lastIndexOf(java.lang.Object)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
449 <DD>Returns the index in this list of the last occurrence of the specified
450 element, or -1 if this list does not contain this element.
451 More formally, returns the highest index <tt>i</tt> such that
452 <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>,
453 or -1 if there is no such index.
455 <DD><DL>
456 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#lastIndexOf(java.lang.Object)" title="class or interface in java.util">lastIndexOf</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
457 </DD>
458 <DD><DL>
459 <DT><B>Parameters:</B><DD><CODE>element</CODE> - element to search for.
460 <DT><B>Returns:</B><DD>the index in this list of the last occurrence of the specified
461 element, or -1 if this list does not contain this element.</DL>
462 </DD>
463 </DL>
464 <HR>
466 <A NAME="listIterator()"><!-- --></A><H3>
467 listIterator</H3>
468 <PRE>
469 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/ListIterator.html" title="class or interface in java.util">ListIterator</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt; <B>listIterator</B>()</PRE>
470 <DL>
471 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#listIterator()" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
472 <DD>Returns a list iterator of the elements in this list (in proper
473 sequence).
475 <DD><DL>
476 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#listIterator()" title="class or interface in java.util">listIterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
477 </DD>
478 <DD><DL>
480 <DT><B>Returns:</B><DD>a list iterator of the elements in this list (in proper
481 sequence).</DL>
482 </DD>
483 </DL>
484 <HR>
486 <A NAME="listIterator(int)"><!-- --></A><H3>
487 listIterator</H3>
488 <PRE>
489 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/ListIterator.html" title="class or interface in java.util">ListIterator</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt; <B>listIterator</B>(int&nbsp;index)</PRE>
490 <DL>
491 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#listIterator(int)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
492 <DD>Returns a list iterator of the elements in this list (in proper
493 sequence), starting at the specified position in this list. The
494 specified index indicates the first element that would be returned by
495 an initial call to the <tt>next</tt> method. An initial call to
496 the <tt>previous</tt> method would return the element with the
497 specified index minus one.
499 <DD><DL>
500 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#listIterator(int)" title="class or interface in java.util">listIterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
501 </DD>
502 <DD><DL>
503 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index of first element to be returned from the
504 list iterator (by a call to the <tt>next</tt> method).
505 <DT><B>Returns:</B><DD>a list iterator of the elements in this list (in proper
506 sequence), starting at the specified position in this list.</DL>
507 </DD>
508 </DL>
509 <HR>
511 <A NAME="remove(int)"><!-- --></A><H3>
512 remove</H3>
513 <PRE>
514 public <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A> <B>remove</B>(int&nbsp;index)</PRE>
515 <DL>
516 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#remove(int)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
517 <DD>Removes the element at the specified position in this list (optional
518 operation). Shifts any subsequent elements to the left (subtracts one
519 from their indices). Returns the element that was removed from the
520 list.
522 <DD><DL>
523 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#remove(int)" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
524 </DD>
525 <DD><DL>
526 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the element to removed.
527 <DT><B>Returns:</B><DD>the element previously at the specified position.</DL>
528 </DD>
529 </DL>
530 <HR>
532 <A NAME="set(int,java.lang.Object)"><!-- --></A><A NAME="set(int, E)"><!-- --></A><H3>
533 set</H3>
534 <PRE>
535 public <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A> <B>set</B>(int&nbsp;index,
536 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&nbsp;element)</PRE>
537 <DL>
538 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#set(int, E)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
539 <DD>Replaces the element at the specified position in this list with the
540 specified element (optional operation).
542 <DD><DL>
543 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#set(int, E)" title="class or interface in java.util">set</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
544 </DD>
545 <DD><DL>
546 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index of element to replace.<DD><CODE>element</CODE> - element to be stored at the specified position.
547 <DT><B>Returns:</B><DD>the element previously at the specified position.</DL>
548 </DD>
549 </DL>
550 <HR>
552 <A NAME="subList(int, int)"><!-- --></A><H3>
553 subList</H3>
554 <PRE>
555 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt; <B>subList</B>(int&nbsp;fromIndex,
556 int&nbsp;toIndex)</PRE>
557 <DL>
558 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#subList(int, int)" title="class or interface in java.util">java.util.List</A></CODE></B></DD>
559 <DD>Returns a view of the portion of this list between the specified
560 <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, exclusive. (If
561 <tt>fromIndex</tt> and <tt>toIndex</tt> are equal, the returned list is
562 empty.) The returned list is backed by this list, so non-structural
563 changes in the returned list are reflected in this list, and vice-versa.
564 The returned list supports all of the optional list operations supported
565 by this list.<p>
567 This method eliminates the need for explicit range operations (of
568 the sort that commonly exist for arrays). Any operation that expects
569 a list can be used as a range operation by passing a subList view
570 instead of a whole list. For example, the following idiom
571 removes a range of elements from a list:
572 <pre>
573 list.subList(from, to).clear();
574 </pre>
575 Similar idioms may be constructed for <tt>indexOf</tt> and
576 <tt>lastIndexOf</tt>, and all of the algorithms in the
577 <tt>Collections</tt> class can be applied to a subList.<p>
579 The semantics of the list returned by this method become undefined if
580 the backing list (i.e., this list) is <i>structurally modified</i> in
581 any way other than via the returned list. (Structural modifications are
582 those that change the size of this list, or otherwise perturb it in such
583 a fashion that iterations in progress may yield incorrect results.)
585 <DD><DL>
586 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#subList(int, int)" title="class or interface in java.util">subList</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE></DL>
587 </DD>
588 <DD><DL>
589 <DT><B>Parameters:</B><DD><CODE>fromIndex</CODE> - low endpoint (inclusive) of the subList.<DD><CODE>toIndex</CODE> - high endpoint (exclusive) of the subList.
590 <DT><B>Returns:</B><DD>a view of the specified range within this list.</DL>
591 </DD>
592 </DL>
593 <HR>
595 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
596 equals</H3>
597 <PRE>
598 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>
599 <DL>
600 <DD><B>Description copied from class: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">java.lang.Object</A></CODE></B></DD>
601 <DD>Indicates whether some other object is "equal to" this one.
603 The <code>equals</code> method implements an equivalence relation
604 on non-null object references:
605 <ul>
606 <li>It is <i>reflexive</i>: for any non-null reference value
607 <code>x</code>, <code>x.equals(x)</code> should return
608 <code>true</code>.
609 <li>It is <i>symmetric</i>: for any non-null reference values
610 <code>x</code> and <code>y</code>, <code>x.equals(y)</code>
611 should return <code>true</code> if and only if
612 <code>y.equals(x)</code> returns <code>true</code>.
613 <li>It is <i>transitive</i>: for any non-null reference values
614 <code>x</code>, <code>y</code>, and <code>z</code>, if
615 <code>x.equals(y)</code> returns <code>true</code> and
616 <code>y.equals(z)</code> returns <code>true</code>, then
617 <code>x.equals(z)</code> should return <code>true</code>.
618 <li>It is <i>consistent</i>: for any non-null reference values
619 <code>x</code> and <code>y</code>, multiple invocations of
620 <tt>x.equals(y)</tt> consistently return <code>true</code>
621 or consistently return <code>false</code>, provided no
622 information used in <code>equals</code> comparisons on the
623 objects is modified.
624 <li>For any non-null reference value <code>x</code>,
625 <code>x.equals(null)</code> should return <code>false</code>.
626 </ul>
628 The <tt>equals</tt> method for class <code>Object</code> implements
629 the most discriminating possible equivalence relation on objects;
630 that is, for any non-null reference values <code>x</code> and
631 <code>y</code>, this method returns <code>true</code> if and only
632 if <code>x</code> and <code>y</code> refer to the same object
633 (<code>x == y</code> has the value <code>true</code>).
635 Note that it is generally necessary to override the <tt>hashCode</tt>
636 method whenever this method is overridden, so as to maintain the
637 general contract for the <tt>hashCode</tt> method, which states
638 that equal objects must have equal hash codes.
640 <DD><DL>
641 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#equals(java.lang.Object)" title="class or interface in java.util">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#equals(java.lang.Object)" title="class or interface in java.util">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL>
642 </DD>
643 <DD><DL>
644 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
645 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
646 argument; <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang"><CODE>Object.hashCode()</CODE></A>,
647 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
648 </DD>
649 </DL>
650 <HR>
652 <A NAME="hashCode()"><!-- --></A><H3>
653 hashCode</H3>
654 <PRE>
655 public int <B>hashCode</B>()</PRE>
656 <DL>
657 <DD><B>Description copied from class: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">java.lang.Object</A></CODE></B></DD>
658 <DD>Returns a hash code value for the object. This method is
659 supported for the benefit of hashtables such as those provided by
660 <code>java.util.Hashtable</code>.
662 The general contract of <code>hashCode</code> is:
663 <ul>
664 <li>Whenever it is invoked on the same object more than once during
665 an execution of a Java application, the <tt>hashCode</tt> method
666 must consistently return the same integer, provided no information
667 used in <tt>equals</tt> comparisons on the object is modified.
668 This integer need not remain consistent from one execution of an
669 application to another execution of the same application.
670 <li>If two objects are equal according to the <tt>equals(Object)</tt>
671 method, then calling the <code>hashCode</code> method on each of
672 the two objects must produce the same integer result.
673 <li>It is <em>not</em> required that if two objects are unequal
674 according to the <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>
675 method, then calling the <tt>hashCode</tt> method on each of the
676 two objects must produce distinct integer results. However, the
677 programmer should be aware that producing distinct integer results
678 for unequal objects may improve the performance of hashtables.
679 </ul>
681 As much as is reasonably practical, the hashCode method defined by
682 class <tt>Object</tt> does return distinct integers for distinct
683 objects. (This is typically implemented by converting the internal
684 address of the object into an integer, but this implementation
685 technique is not required by the
686 Java<font size="-2"><sup>TM</sup></font> programming language.)
688 <DD><DL>
689 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#hashCode()" title="class or interface in java.util">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html#hashCode()" title="class or interface in java.util">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingList.html" title="type parameter in ForwardingList">E</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL>
690 </DD>
691 <DD><DL>
693 <DT><B>Returns:</B><DD>a hash code value for this object.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>,
694 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
695 </DD>
696 </DL>
697 <!-- ========= END OF CLASS DATA ========= -->
698 <HR>
701 <!-- ======= START OF BOTTOM NAVBAR ====== -->
702 <A NAME="navbar_bottom"><!-- --></A>
703 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
704 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
705 <TR>
706 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
707 <A NAME="navbar_bottom_firstrow"><!-- --></A>
708 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
709 <TR ALIGN="center" VALIGN="top">
710 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
711 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
712 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
713 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
714 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
715 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
716 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
717 </TR>
718 </TABLE>
719 </TD>
720 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
721 </EM>
722 </TD>
723 </TR>
725 <TR>
726 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
727 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
728 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingListIterator.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
729 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
730 <A HREF="../../../../index.html?com/google/common/collect/ForwardingList.html" target="_top"><B>FRAMES</B></A> &nbsp;
731 &nbsp;<A HREF="ForwardingList.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
732 &nbsp;<SCRIPT type="text/javascript">
733 <!--
734 if(window==top) {
735 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
737 //-->
738 </SCRIPT>
739 <NOSCRIPT>
740 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
741 </NOSCRIPT>
744 </FONT></TD>
745 </TR>
746 <TR>
747 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
748 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
749 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
750 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
751 </TR>
752 </TABLE>
753 <A NAME="skip-navbar_bottom"></A>
754 <!-- ======== END OF BOTTOM NAVBAR ======= -->
756 <HR>
758 </BODY>
759 </HTML>