a whole bunch of stuff
[ephemerata.git] / KezvhLib / lib / com.google.com.collect / javadoc / com / google / common / collect / ForwardingMapEntry.html
blobee07ba00e06114347525ec1c5b359a4581c09e00
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:45 PDT 2008 -->
6 <TITLE>
7 ForwardingMapEntry (Google Collections Library - snapshot-20080820 (ALPHA))
8 </TITLE>
10 <META NAME="keywords" CONTENT="com.google.common.collect.ForwardingMapEntry 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="ForwardingMapEntry (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/ForwardingMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMultimap.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/ForwardingMapEntry.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="ForwardingMapEntry.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 ForwardingMapEntry&lt;K,V&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 "><B>com.google.common.collect.ForwardingMapEntry&lt;K,V&gt;</B>
94 </PRE>
95 <DL>
96 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;K,V&gt;</DD>
97 </DL>
98 <HR>
99 <DL>
100 <DT><PRE>public abstract class <B>ForwardingMapEntry&lt;K,V&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;K,V&gt;</DL>
101 </PRE>
104 A map entry which forwards all its method calls to another map entry.
105 Subclasses should override one or more methods to modify the behavior of the
106 backing map entry as desired per the <a
107 href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
111 <DL>
112 <DT><B>Author:</B></DT>
113 <DD>Mike Bostock</DD>
114 <DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A></DL>
115 <HR>
119 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
121 <A NAME="constructor_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125 <B>Constructor Summary</B></FONT></TH>
126 </TR>
127 <TR BGCOLOR="white" CLASS="TableRowColor">
128 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#ForwardingMapEntry()">ForwardingMapEntry</A></B>()</CODE>
130 <BR>
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132 </TR>
133 </TABLE>
134 &nbsp;
135 <!-- ========== METHOD SUMMARY =========== -->
137 <A NAME="method_summary"><!-- --></A>
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141 <B>Method Summary</B></FONT></TH>
142 </TR>
143 <TR BGCOLOR="white" CLASS="TableRowColor">
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145 <CODE>protected abstract &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&gt;</CODE></FONT></TD>
146 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#delegate()">delegate</A></B>()</CODE>
148 <BR>
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backing delegate instance that methods are forwarded to.</TD>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153 <CODE>&nbsp;boolean</CODE></FONT></TD>
154 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.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>
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether some other object is "equal to" this one.</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A></CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#getKey()">getKey</A></B>()</CODE>
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the key corresponding to this entry.</TD>
166 </TR>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A></CODE></FONT></TD>
170 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#getValue()">getValue</A></B>()</CODE>
172 <BR>
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value corresponding to this entry.</TD>
174 </TR>
175 <TR BGCOLOR="white" CLASS="TableRowColor">
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177 <CODE>&nbsp;int</CODE></FONT></TD>
178 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#hashCode()">hashCode</A></B>()</CODE>
180 <BR>
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash code value for the object.</TD>
182 </TR>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A></CODE></FONT></TD>
186 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html#setValue(V)">setValue</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&nbsp;value)</CODE>
188 <BR>
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the value corresponding to this entry with the specified
190 value (optional operation).</TD>
191 </TR>
192 </TABLE>
193 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A>
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
196 <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>
197 </TR>
198 <TR BGCOLOR="white" CLASS="TableRowColor">
199 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD>
200 </TR>
201 </TABLE>
202 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
203 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
205 <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>
206 </TR>
207 <TR BGCOLOR="white" CLASS="TableRowColor">
208 <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>
209 </TR>
210 </TABLE>
211 &nbsp;
214 <!-- ========= CONSTRUCTOR DETAIL ======== -->
216 <A NAME="constructor_detail"><!-- --></A>
217 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
219 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
220 <B>Constructor Detail</B></FONT></TH>
221 </TR>
222 </TABLE>
224 <A NAME="ForwardingMapEntry()"><!-- --></A><H3>
225 ForwardingMapEntry</H3>
226 <PRE>
227 public <B>ForwardingMapEntry</B>()</PRE>
228 <DL>
229 </DL>
231 <!-- ============ METHOD DETAIL ========== -->
233 <A NAME="method_detail"><!-- --></A>
234 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
235 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
236 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
237 <B>Method Detail</B></FONT></TH>
238 </TR>
239 </TABLE>
241 <A NAME="delegate()"><!-- --></A><H3>
242 delegate</H3>
243 <PRE>
244 protected abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&gt; <B>delegate</B>()</PRE>
245 <DL>
246 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD>
247 <DD>Returns the backing delegate instance that methods are forwarded to.
248 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
249 with an abstract method that has a more specific return type, such as
250 <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to
251 supply the instance being decorated.
253 <DD><DL>
254 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></CODE></DL>
255 </DD>
256 <DD><DL>
257 </DL>
258 </DD>
259 </DL>
260 <HR>
262 <A NAME="getKey()"><!-- --></A><H3>
263 getKey</H3>
264 <PRE>
265 public <A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A> <B>getKey</B>()</PRE>
266 <DL>
267 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#getKey()" title="class or interface in java.util">java.util.Map.Entry</A></CODE></B></DD>
268 <DD>Returns the key corresponding to this entry.
270 <DD><DL>
271 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#getKey()" title="class or interface in java.util">getKey</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&gt;</CODE></DL>
272 </DD>
273 <DD><DL>
275 <DT><B>Returns:</B><DD>the key corresponding to this entry.</DL>
276 </DD>
277 </DL>
278 <HR>
280 <A NAME="getValue()"><!-- --></A><H3>
281 getValue</H3>
282 <PRE>
283 public <A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A> <B>getValue</B>()</PRE>
284 <DL>
285 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#getValue()" title="class or interface in java.util">java.util.Map.Entry</A></CODE></B></DD>
286 <DD>Returns the value corresponding to this entry. If the mapping
287 has been removed from the backing map (by the iterator's
288 <tt>remove</tt> operation), the results of this call are undefined.
290 <DD><DL>
291 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#getValue()" title="class or interface in java.util">getValue</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&gt;</CODE></DL>
292 </DD>
293 <DD><DL>
295 <DT><B>Returns:</B><DD>the value corresponding to this entry.</DL>
296 </DD>
297 </DL>
298 <HR>
300 <A NAME="setValue(java.lang.Object)"><!-- --></A><A NAME="setValue(V)"><!-- --></A><H3>
301 setValue</H3>
302 <PRE>
303 public <A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A> <B>setValue</B>(<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&nbsp;value)</PRE>
304 <DL>
305 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#setValue(V)" title="class or interface in java.util">java.util.Map.Entry</A></CODE></B></DD>
306 <DD>Replaces the value corresponding to this entry with the specified
307 value (optional operation). (Writes through to the map.) The
308 behavior of this call is undefined if the mapping has already been
309 removed from the map (by the iterator's <tt>remove</tt> operation).
311 <DD><DL>
312 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html#setValue(V)" title="class or interface in java.util">setValue</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</A>&gt;</CODE></DL>
313 </DD>
314 <DD><DL>
315 <DT><B>Parameters:</B><DD><CODE>value</CODE> - new value to be stored in this entry.
316 <DT><B>Returns:</B><DD>old value corresponding to the entry.</DL>
317 </DD>
318 </DL>
319 <HR>
321 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
322 equals</H3>
323 <PRE>
324 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>
325 <DL>
326 <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>
327 <DD>Indicates whether some other object is "equal to" this one.
329 The <code>equals</code> method implements an equivalence relation
330 on non-null object references:
331 <ul>
332 <li>It is <i>reflexive</i>: for any non-null reference value
333 <code>x</code>, <code>x.equals(x)</code> should return
334 <code>true</code>.
335 <li>It is <i>symmetric</i>: for any non-null reference values
336 <code>x</code> and <code>y</code>, <code>x.equals(y)</code>
337 should return <code>true</code> if and only if
338 <code>y.equals(x)</code> returns <code>true</code>.
339 <li>It is <i>transitive</i>: for any non-null reference values
340 <code>x</code>, <code>y</code>, and <code>z</code>, if
341 <code>x.equals(y)</code> returns <code>true</code> and
342 <code>y.equals(z)</code> returns <code>true</code>, then
343 <code>x.equals(z)</code> should return <code>true</code>.
344 <li>It is <i>consistent</i>: for any non-null reference values
345 <code>x</code> and <code>y</code>, multiple invocations of
346 <tt>x.equals(y)</tt> consistently return <code>true</code>
347 or consistently return <code>false</code>, provided no
348 information used in <code>equals</code> comparisons on the
349 objects is modified.
350 <li>For any non-null reference value <code>x</code>,
351 <code>x.equals(null)</code> should return <code>false</code>.
352 </ul>
354 The <tt>equals</tt> method for class <code>Object</code> implements
355 the most discriminating possible equivalence relation on objects;
356 that is, for any non-null reference values <code>x</code> and
357 <code>y</code>, this method returns <code>true</code> if and only
358 if <code>x</code> and <code>y</code> refer to the same object
359 (<code>x == y</code> has the value <code>true</code>).
361 Note that it is generally necessary to override the <tt>hashCode</tt>
362 method whenever this method is overridden, so as to maintain the
363 general contract for the <tt>hashCode</tt> method, which states
364 that equal objects must have equal hash codes.
366 <DD><DL>
367 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.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/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</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>
368 </DD>
369 <DD><DL>
370 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
371 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
372 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>,
373 <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>
374 </DD>
375 </DL>
376 <HR>
378 <A NAME="hashCode()"><!-- --></A><H3>
379 hashCode</H3>
380 <PRE>
381 public int <B>hashCode</B>()</PRE>
382 <DL>
383 <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>
384 <DD>Returns a hash code value for the object. This method is
385 supported for the benefit of hashtables such as those provided by
386 <code>java.util.Hashtable</code>.
388 The general contract of <code>hashCode</code> is:
389 <ul>
390 <li>Whenever it is invoked on the same object more than once during
391 an execution of a Java application, the <tt>hashCode</tt> method
392 must consistently return the same integer, provided no information
393 used in <tt>equals</tt> comparisons on the object is modified.
394 This integer need not remain consistent from one execution of an
395 application to another execution of the same application.
396 <li>If two objects are equal according to the <tt>equals(Object)</tt>
397 method, then calling the <code>hashCode</code> method on each of
398 the two objects must produce the same integer result.
399 <li>It is <em>not</em> required that if two objects are unequal
400 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>
401 method, then calling the <tt>hashCode</tt> method on each of the
402 two objects must produce distinct integer results. However, the
403 programmer should be aware that producing distinct integer results
404 for unequal objects may improve the performance of hashtables.
405 </ul>
407 As much as is reasonably practical, the hashCode method defined by
408 class <tt>Object</tt> does return distinct integers for distinct
409 objects. (This is typically implemented by converting the internal
410 address of the object into an integer, but this implementation
411 technique is not required by the
412 Java<font size="-2"><sup>TM</sup></font> programming language.)
414 <DD><DL>
415 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.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/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="type parameter in ForwardingMapEntry">V</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>
416 </DD>
417 <DD><DL>
419 <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>,
420 <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>
421 </DD>
422 </DL>
423 <!-- ========= END OF CLASS DATA ========= -->
424 <HR>
427 <!-- ======= START OF BOTTOM NAVBAR ====== -->
428 <A NAME="navbar_bottom"><!-- --></A>
429 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
430 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
431 <TR>
432 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
433 <A NAME="navbar_bottom_firstrow"><!-- --></A>
434 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
435 <TR ALIGN="center" VALIGN="top">
436 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
437 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
438 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
439 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
440 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
441 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
442 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
443 </TR>
444 </TABLE>
445 </TD>
446 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
447 </EM>
448 </TD>
449 </TR>
451 <TR>
452 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
453 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
454 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
455 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
456 <A HREF="../../../../index.html?com/google/common/collect/ForwardingMapEntry.html" target="_top"><B>FRAMES</B></A> &nbsp;
457 &nbsp;<A HREF="ForwardingMapEntry.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
458 &nbsp;<SCRIPT type="text/javascript">
459 <!--
460 if(window==top) {
461 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
463 //-->
464 </SCRIPT>
465 <NOSCRIPT>
466 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
467 </NOSCRIPT>
470 </FONT></TD>
471 </TR>
472 <TR>
473 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
474 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
475 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
476 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
477 </TR>
478 </TABLE>
479 <A NAME="skip-navbar_bottom"></A>
480 <!-- ======== END OF BOTTOM NAVBAR ======= -->
482 <HR>
484 </BODY>
485 </HTML>