a whole bunch of stuff
[ephemerata.git] / KezvhLib / lib / com.google.com.collect / javadoc / com / google / common / collect / ForwardingMap.html
blob2001d59223878363137791ae8bcbc6fffe3f6dc3
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 ForwardingMap (Google Collections Library - snapshot-20080820 (ALPHA))
8 </TITLE>
10 <META NAME="keywords" CONTENT="com.google.common.collect.ForwardingMap 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="ForwardingMap (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/ForwardingListIterator.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.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/ForwardingMap.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="ForwardingMap.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 ForwardingMap&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.ForwardingMap&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.html" title="class or interface in java.util">Map</A>&lt;K,V&gt;</DD>
97 </DL>
98 <DL>
99 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/google/common/collect/EnumBiMap.html" title="class in com.google.common.collect">EnumBiMap</A>, <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="class in com.google.common.collect">EnumHashBiMap</A>, <A HREF="../../../../com/google/common/collect/ForwardingConcurrentMap.html" title="class in com.google.common.collect">ForwardingConcurrentMap</A>, <A HREF="../../../../com/google/common/collect/ForwardingSortedMap.html" title="class in com.google.common.collect">ForwardingSortedMap</A>, <A HREF="../../../../com/google/common/collect/HashBiMap.html" title="class in com.google.common.collect">HashBiMap</A></DD>
100 </DL>
101 <HR>
102 <DL>
103 <DT><PRE>public abstract class <B>ForwardingMap&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.html" title="class or interface in java.util">Map</A>&lt;K,V&gt;</DL>
104 </PRE>
107 A map which forwards all its method calls to another map. Subclasses should
108 override one or more methods to modify the behavior of the backing map as
109 desired per the <a
110 href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
114 <DL>
115 <DT><B>Author:</B></DT>
116 <DD>Kevin Bourrillion, Jared Levy</DD>
117 <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>
118 <HR>
121 <!-- ======== NESTED CLASS SUMMARY ======== -->
123 <A NAME="nested_class_summary"><!-- --></A>
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127 <B>Nested Class Summary</B></FONT></TH>
128 </TR>
129 </TABLE>
130 &nbsp;<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
131 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A></B></TH>
134 </TR>
135 <TR BGCOLOR="white" CLASS="TableRowColor">
136 <TD><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="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">K</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">V</A>&gt;</CODE></TD>
137 </TR>
138 </TABLE>
139 &nbsp;
141 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
143 <A NAME="constructor_summary"><!-- --></A>
144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147 <B>Constructor Summary</B></FONT></TH>
148 </TR>
149 <TR BGCOLOR="white" CLASS="TableRowColor">
150 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#ForwardingMap()">ForwardingMap</A></B>()</CODE>
152 <BR>
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
154 </TR>
155 </TABLE>
156 &nbsp;
157 <!-- ========== METHOD SUMMARY =========== -->
159 <A NAME="method_summary"><!-- --></A>
160 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
163 <B>Method Summary</B></FONT></TH>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>&nbsp;void</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#clear()">clear</A></B>()</CODE>
170 <BR>
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all mappings from this map (optional operation).</TD>
172 </TR>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175 <CODE>&nbsp;boolean</CODE></FONT></TD>
176 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#containsKey(java.lang.Object)">containsKey</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;key)</CODE>
178 <BR>
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map contains a mapping for the specified
180 key.</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;boolean</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#containsValue(java.lang.Object)">containsValue</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;value)</CODE>
187 <BR>
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map maps one or more keys to the
189 specified value.</TD>
190 </TR>
191 <TR BGCOLOR="white" CLASS="TableRowColor">
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193 <CODE>protected abstract &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></FONT></TD>
194 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#delegate()">delegate</A></B>()</CODE>
196 <BR>
197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backing delegate instance that methods are forwarded to.</TD>
198 </TR>
199 <TR BGCOLOR="white" CLASS="TableRowColor">
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<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/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;&gt;</CODE></FONT></TD>
202 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#entrySet()">entrySet</A></B>()</CODE>
204 <BR>
205 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a set view of the mappings contained in this map.</TD>
206 </TR>
207 <TR BGCOLOR="white" CLASS="TableRowColor">
208 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209 <CODE>&nbsp;boolean</CODE></FONT></TD>
210 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.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>
212 <BR>
213 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether some other object is "equal to" this one.</TD>
214 </TR>
215 <TR BGCOLOR="white" CLASS="TableRowColor">
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A></CODE></FONT></TD>
218 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#get(java.lang.Object)">get</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;key)</CODE>
220 <BR>
221 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value to which this map maps the specified key.</TD>
222 </TR>
223 <TR BGCOLOR="white" CLASS="TableRowColor">
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225 <CODE>&nbsp;int</CODE></FONT></TD>
226 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#hashCode()">hashCode</A></B>()</CODE>
228 <BR>
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash code value for the object.</TD>
230 </TR>
231 <TR BGCOLOR="white" CLASS="TableRowColor">
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233 <CODE>&nbsp;boolean</CODE></FONT></TD>
234 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#isEmpty()">isEmpty</A></B>()</CODE>
236 <BR>
237 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map contains no key-value mappings.</TD>
238 </TR>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>&gt;</CODE></FONT></TD>
242 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#keySet()">keySet</A></B>()</CODE>
244 <BR>
245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a set view of the keys contained in this map.</TD>
246 </TR>
247 <TR BGCOLOR="white" CLASS="TableRowColor">
248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A></CODE></FONT></TD>
250 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#put(K, V)">put</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>&nbsp;key,
251 <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&nbsp;value)</CODE>
253 <BR>
254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Associates the specified value with the specified key in this map
255 (optional operation).</TD>
256 </TR>
257 <TR BGCOLOR="white" CLASS="TableRowColor">
258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259 <CODE>&nbsp;void</CODE></FONT></TD>
260 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#putAll(java.util.Map)">putAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;? extends <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;&nbsp;map)</CODE>
262 <BR>
263 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies all of the mappings from the specified map to this map
264 (optional operation).</TD>
265 </TR>
266 <TR BGCOLOR="white" CLASS="TableRowColor">
267 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A></CODE></FONT></TD>
269 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#remove(java.lang.Object)">remove</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;object)</CODE>
271 <BR>
272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the mapping for this key from this map if it is present
273 (optional operation).</TD>
274 </TR>
275 <TR BGCOLOR="white" CLASS="TableRowColor">
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277 <CODE>&nbsp;int</CODE></FONT></TD>
278 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#size()">size</A></B>()</CODE>
280 <BR>
281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of key-value mappings in this map.</TD>
282 </TR>
283 <TR BGCOLOR="white" CLASS="TableRowColor">
284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285 <CODE>&nbsp;<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/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></FONT></TD>
286 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMap.html#values()">values</A></B>()</CODE>
288 <BR>
289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection view of the values contained in this map.</TD>
290 </TR>
291 </TABLE>
292 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A>
293 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
294 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
295 <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>
296 </TR>
297 <TR BGCOLOR="white" CLASS="TableRowColor">
298 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD>
299 </TR>
300 </TABLE>
301 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
302 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
303 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
304 <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>
305 </TR>
306 <TR BGCOLOR="white" CLASS="TableRowColor">
307 <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>
308 </TR>
309 </TABLE>
310 &nbsp;
313 <!-- ========= CONSTRUCTOR DETAIL ======== -->
315 <A NAME="constructor_detail"><!-- --></A>
316 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
317 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
318 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
319 <B>Constructor Detail</B></FONT></TH>
320 </TR>
321 </TABLE>
323 <A NAME="ForwardingMap()"><!-- --></A><H3>
324 ForwardingMap</H3>
325 <PRE>
326 public <B>ForwardingMap</B>()</PRE>
327 <DL>
328 </DL>
330 <!-- ============ METHOD DETAIL ========== -->
332 <A NAME="method_detail"><!-- --></A>
333 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
334 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
335 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
336 <B>Method Detail</B></FONT></TH>
337 </TR>
338 </TABLE>
340 <A NAME="delegate()"><!-- --></A><H3>
341 delegate</H3>
342 <PRE>
343 protected abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt; <B>delegate</B>()</PRE>
344 <DL>
345 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD>
346 <DD>Returns the backing delegate instance that methods are forwarded to.
347 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
348 with an abstract method that has a more specific return type, such as
349 <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to
350 supply the instance being decorated.
352 <DD><DL>
353 <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>
354 </DD>
355 <DD><DL>
356 </DL>
357 </DD>
358 </DL>
359 <HR>
361 <A NAME="size()"><!-- --></A><H3>
362 size</H3>
363 <PRE>
364 public int <B>size</B>()</PRE>
365 <DL>
366 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#size()" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
367 <DD>Returns the number of key-value mappings in this map. If the
368 map contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
369 <tt>Integer.MAX_VALUE</tt>.
371 <DD><DL>
372 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#size()" title="class or interface in java.util">size</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
373 </DD>
374 <DD><DL>
376 <DT><B>Returns:</B><DD>the number of key-value mappings in this map.</DL>
377 </DD>
378 </DL>
379 <HR>
381 <A NAME="isEmpty()"><!-- --></A><H3>
382 isEmpty</H3>
383 <PRE>
384 public boolean <B>isEmpty</B>()</PRE>
385 <DL>
386 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#isEmpty()" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
387 <DD>Returns <tt>true</tt> if this map contains no key-value mappings.
389 <DD><DL>
390 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#isEmpty()" title="class or interface in java.util">isEmpty</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
391 </DD>
392 <DD><DL>
394 <DT><B>Returns:</B><DD><tt>true</tt> if this map contains no key-value mappings.</DL>
395 </DD>
396 </DL>
397 <HR>
399 <A NAME="remove(java.lang.Object)"><!-- --></A><H3>
400 remove</H3>
401 <PRE>
402 public <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A> <B>remove</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;object)</PRE>
403 <DL>
404 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#remove(java.lang.Object)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
405 <DD>Removes the mapping for this key from this map if it is present
406 (optional operation). More formally, if this map contains a mapping
407 from key <tt>k</tt> to value <tt>v</tt> such that
408 <code>(key==null ? k==null : key.equals(k))</code>, that mapping
409 is removed. (The map can contain at most one such mapping.)
411 <p>Returns the value to which the map previously associated the key, or
412 <tt>null</tt> if the map contained no mapping for this key. (A
413 <tt>null</tt> return can also indicate that the map previously
414 associated <tt>null</tt> with the specified key if the implementation
415 supports <tt>null</tt> values.) The map will not contain a mapping for
416 the specified key once the call returns.
418 <DD><DL>
419 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#remove(java.lang.Object)" 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/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
420 </DD>
421 <DD><DL>
422 <DT><B>Parameters:</B><DD><CODE>object</CODE> - key whose mapping is to be removed from the map.
423 <DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
424 if there was no mapping for key.</DL>
425 </DD>
426 </DL>
427 <HR>
429 <A NAME="clear()"><!-- --></A><H3>
430 clear</H3>
431 <PRE>
432 public void <B>clear</B>()</PRE>
433 <DL>
434 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#clear()" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
435 <DD>Removes all mappings from this map (optional operation).
437 <DD><DL>
438 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#clear()" title="class or interface in java.util">clear</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
439 </DD>
440 <DD><DL>
441 </DL>
442 </DD>
443 </DL>
444 <HR>
446 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
447 containsKey</H3>
448 <PRE>
449 public boolean <B>containsKey</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;key)</PRE>
450 <DL>
451 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsKey(java.lang.Object)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
452 <DD>Returns <tt>true</tt> if this map contains a mapping for the specified
453 key. More formally, returns <tt>true</tt> if and only if
454 this map contains a mapping for a key <tt>k</tt> such that
455 <tt>(key==null ? k==null : key.equals(k))</tt>. (There can be
456 at most one such mapping.)
458 <DD><DL>
459 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsKey(java.lang.Object)" title="class or interface in java.util">containsKey</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
460 </DD>
461 <DD><DL>
462 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose presence in this map is to be tested.
463 <DT><B>Returns:</B><DD><tt>true</tt> if this map contains a mapping for the specified
464 key.</DL>
465 </DD>
466 </DL>
467 <HR>
469 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
470 containsValue</H3>
471 <PRE>
472 public boolean <B>containsValue</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;value)</PRE>
473 <DL>
474 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsValue(java.lang.Object)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
475 <DD>Returns <tt>true</tt> if this map maps one or more keys to the
476 specified value. More formally, returns <tt>true</tt> if and only if
477 this map contains at least one mapping to a value <tt>v</tt> such that
478 <tt>(value==null ? v==null : value.equals(v))</tt>. This operation
479 will probably require time linear in the map size for most
480 implementations of the <tt>Map</tt> interface.
482 <DD><DL>
483 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsValue(java.lang.Object)" title="class or interface in java.util">containsValue</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
484 </DD>
485 <DD><DL>
486 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value whose presence in this map is to be tested.
487 <DT><B>Returns:</B><DD><tt>true</tt> if this map maps one or more keys to the
488 specified value.</DL>
489 </DD>
490 </DL>
491 <HR>
493 <A NAME="get(java.lang.Object)"><!-- --></A><H3>
494 get</H3>
495 <PRE>
496 public <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A> <B>get</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;key)</PRE>
497 <DL>
498 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#get(java.lang.Object)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
499 <DD>Returns the value to which this map maps the specified key. Returns
500 <tt>null</tt> if the map contains no mapping for this key. A return
501 value of <tt>null</tt> does not <i>necessarily</i> indicate that the
502 map contains no mapping for the key; it's also possible that the map
503 explicitly maps the key to <tt>null</tt>. The <tt>containsKey</tt>
504 operation may be used to distinguish these two cases.
506 <p>More formally, if this map contains a mapping from a key
507 <tt>k</tt> to a value <tt>v</tt> such that <tt>(key==null ? k==null :
508 key.equals(k))</tt>, then this method returns <tt>v</tt>; otherwise
509 it returns <tt>null</tt>. (There can be at most one such mapping.)
511 <DD><DL>
512 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#get(java.lang.Object)" 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/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
513 </DD>
514 <DD><DL>
515 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose associated value is to be returned.
516 <DT><B>Returns:</B><DD>the value to which this map maps the specified key, or
517 <tt>null</tt> if the map contains no mapping for this key.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsKey(java.lang.Object)" title="class or interface in java.util"><CODE>Map.containsKey(Object)</CODE></A></DL>
518 </DD>
519 </DL>
520 <HR>
522 <A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3>
523 put</H3>
524 <PRE>
525 public <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A> <B>put</B>(<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>&nbsp;key,
526 <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&nbsp;value)</PRE>
527 <DL>
528 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#put(K, V)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
529 <DD>Associates the specified value with the specified key in this map
530 (optional operation). If the map previously contained a mapping for
531 this key, the old value is replaced by the specified value. (A map
532 <tt>m</tt> is said to contain a mapping for a key <tt>k</tt> if and only
533 if <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#containsKey(java.lang.Object)" title="class or interface in java.util"><CODE>m.containsKey(k)</CODE></A> would return
534 <tt>true</tt>.))
536 <DD><DL>
537 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#put(K, V)" title="class or interface in java.util">put</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
538 </DD>
539 <DD><DL>
540 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key with which the specified value is to be associated.<DD><CODE>value</CODE> - value to be associated with the specified key.
541 <DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
542 if there was no mapping for key. A <tt>null</tt> return can
543 also indicate that the map previously associated <tt>null</tt>
544 with the specified key, if the implementation supports
545 <tt>null</tt> values.</DL>
546 </DD>
547 </DL>
548 <HR>
550 <A NAME="putAll(java.util.Map)"><!-- --></A><H3>
551 putAll</H3>
552 <PRE>
553 public void <B>putAll</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;? extends <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;&nbsp;map)</PRE>
554 <DL>
555 <DD><B>Description copied from interface: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#putAll(java.util.Map)" title="class or interface in java.util">java.util.Map</A></CODE></B></DD>
556 <DD>Copies all of the mappings from the specified map to this map
557 (optional operation). The effect of this call is equivalent to that
558 of calling <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#put(K, V)" title="class or interface in java.util"><CODE>put(k, v)</CODE></A> on this map once
559 for each mapping from key <tt>k</tt> to value <tt>v</tt> in the
560 specified map. The behavior of this operation is unspecified if the
561 specified map is modified while the operation is in progress.
563 <DD><DL>
564 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#putAll(java.util.Map)" title="class or interface in java.util">putAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
565 </DD>
566 <DD><DL>
567 <DT><B>Parameters:</B><DD><CODE>map</CODE> - Mappings to be stored in this map.</DL>
568 </DD>
569 </DL>
570 <HR>
572 <A NAME="keySet()"><!-- --></A><H3>
573 keySet</H3>
574 <PRE>
575 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>&gt; <B>keySet</B>()</PRE>
576 <DL>
577 <DD>Returns a set view of the keys contained in this map. The set is
578 backed by the map, so changes to the map are reflected in the set, and
579 vice-versa. If the map is modified while an iteration over the set is
580 in progress (except through the iterator's own <tt>remove</tt>
581 operation), the results of the iteration are undefined. The set
582 supports element removal, which removes the corresponding mapping from
583 the map, via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
584 <tt>removeAll</tt> <tt>retainAll</tt>, and <tt>clear</tt> operations.
585 It does not support the add or <tt>addAll</tt> operations.
587 <p>The returned set's <code>removeAll</code> and <code>retainAll</code> methods
588 always throw a <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang"><CODE>NullPointerException</CODE></A> when given a null collection.
590 <DD><DL>
591 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#keySet()" title="class or interface in java.util">keySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
592 </DD>
593 <DD><DL>
595 <DT><B>Returns:</B><DD>a set view of the keys contained in this map.</DL>
596 </DD>
597 </DL>
598 <HR>
600 <A NAME="values()"><!-- --></A><H3>
601 values</H3>
602 <PRE>
603 public <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/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt; <B>values</B>()</PRE>
604 <DL>
605 <DD>Returns a collection view of the values contained in this map. The
606 collection is backed by the map, so changes to the map are reflected in
607 the collection, and vice-versa. If the map is modified while an
608 iteration over the collection is in progress (except through the
609 iterator's own <tt>remove</tt> operation), the results of the
610 iteration are undefined. The collection supports element removal,
611 which removes the corresponding mapping from the map, via the
612 <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
613 <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations.
614 It does not support the add or <tt>addAll</tt> operations.
616 <p>The returned collection's <code>removeAll</code> and <code>retainAll</code>
617 methods always throw a <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang"><CODE>NullPointerException</CODE></A> when given a null
618 collection.
620 <DD><DL>
621 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#values()" title="class or interface in java.util">values</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
622 </DD>
623 <DD><DL>
625 <DT><B>Returns:</B><DD>a collection view of the values contained in this map.</DL>
626 </DD>
627 </DL>
628 <HR>
630 <A NAME="entrySet()"><!-- --></A><H3>
631 entrySet</H3>
632 <PRE>
633 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<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/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;&gt; <B>entrySet</B>()</PRE>
634 <DL>
635 <DD>Returns a set view of the mappings contained in this map. Each element
636 in the returned set is a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util"><CODE>Map.Entry</CODE></A>. The set is backed by the
637 map, so changes to the map are reflected in the set, and vice-versa.
638 If the map is modified while an iteration over the set is in progress
639 (except through the iterator's own <tt>remove</tt> operation, or through
640 the <tt>setValue</tt> operation on a map entry returned by the iterator)
641 the results of the iteration are undefined. The set supports element
642 removal, which removes the corresponding mapping from the map, via the
643 <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>,
644 <tt>retainAll</tt> and <tt>clear</tt> operations. It does not support
645 the <tt>add</tt> or <tt>addAll</tt> operations.
647 <p>The returned set's <code>removeAll</code> and <code>retainAll</code> methods
648 always throw a <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang"><CODE>NullPointerException</CODE></A> when given a null collection.
650 <DD><DL>
651 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#entrySet()" title="class or interface in java.util">entrySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">V</A>&gt;</CODE></DL>
652 </DD>
653 <DD><DL>
655 <DT><B>Returns:</B><DD>a set view of the mappings contained in this map.</DL>
656 </DD>
657 </DL>
658 <HR>
660 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
661 equals</H3>
662 <PRE>
663 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>
664 <DL>
665 <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>
666 <DD>Indicates whether some other object is "equal to" this one.
668 The <code>equals</code> method implements an equivalence relation
669 on non-null object references:
670 <ul>
671 <li>It is <i>reflexive</i>: for any non-null reference value
672 <code>x</code>, <code>x.equals(x)</code> should return
673 <code>true</code>.
674 <li>It is <i>symmetric</i>: for any non-null reference values
675 <code>x</code> and <code>y</code>, <code>x.equals(y)</code>
676 should return <code>true</code> if and only if
677 <code>y.equals(x)</code> returns <code>true</code>.
678 <li>It is <i>transitive</i>: for any non-null reference values
679 <code>x</code>, <code>y</code>, and <code>z</code>, if
680 <code>x.equals(y)</code> returns <code>true</code> and
681 <code>y.equals(z)</code> returns <code>true</code>, then
682 <code>x.equals(z)</code> should return <code>true</code>.
683 <li>It is <i>consistent</i>: for any non-null reference values
684 <code>x</code> and <code>y</code>, multiple invocations of
685 <tt>x.equals(y)</tt> consistently return <code>true</code>
686 or consistently return <code>false</code>, provided no
687 information used in <code>equals</code> comparisons on the
688 objects is modified.
689 <li>For any non-null reference value <code>x</code>,
690 <code>x.equals(null)</code> should return <code>false</code>.
691 </ul>
693 The <tt>equals</tt> method for class <code>Object</code> implements
694 the most discriminating possible equivalence relation on objects;
695 that is, for any non-null reference values <code>x</code> and
696 <code>y</code>, this method returns <code>true</code> if and only
697 if <code>x</code> and <code>y</code> refer to the same object
698 (<code>x == y</code> has the value <code>true</code>).
700 Note that it is generally necessary to override the <tt>hashCode</tt>
701 method whenever this method is overridden, so as to maintain the
702 general contract for the <tt>hashCode</tt> method, which states
703 that equal objects must have equal hash codes.
705 <DD><DL>
706 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.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.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">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>
707 </DD>
708 <DD><DL>
709 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
710 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
711 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>,
712 <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>
713 </DD>
714 </DL>
715 <HR>
717 <A NAME="hashCode()"><!-- --></A><H3>
718 hashCode</H3>
719 <PRE>
720 public int <B>hashCode</B>()</PRE>
721 <DL>
722 <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>
723 <DD>Returns a hash code value for the object. This method is
724 supported for the benefit of hashtables such as those provided by
725 <code>java.util.Hashtable</code>.
727 The general contract of <code>hashCode</code> is:
728 <ul>
729 <li>Whenever it is invoked on the same object more than once during
730 an execution of a Java application, the <tt>hashCode</tt> method
731 must consistently return the same integer, provided no information
732 used in <tt>equals</tt> comparisons on the object is modified.
733 This integer need not remain consistent from one execution of an
734 application to another execution of the same application.
735 <li>If two objects are equal according to the <tt>equals(Object)</tt>
736 method, then calling the <code>hashCode</code> method on each of
737 the two objects must produce the same integer result.
738 <li>It is <em>not</em> required that if two objects are unequal
739 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>
740 method, then calling the <tt>hashCode</tt> method on each of the
741 two objects must produce distinct integer results. However, the
742 programmer should be aware that producing distinct integer results
743 for unequal objects may improve the performance of hashtables.
744 </ul>
746 As much as is reasonably practical, the hashCode method defined by
747 class <tt>Object</tt> does return distinct integers for distinct
748 objects. (This is typically implemented by converting the internal
749 address of the object into an integer, but this implementation
750 technique is not required by the
751 Java<font size="-2"><sup>TM</sup></font> programming language.)
753 <DD><DL>
754 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.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.html" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="type parameter in ForwardingMap">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>
755 </DD>
756 <DD><DL>
758 <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>,
759 <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>
760 </DD>
761 </DL>
762 <!-- ========= END OF CLASS DATA ========= -->
763 <HR>
766 <!-- ======= START OF BOTTOM NAVBAR ====== -->
767 <A NAME="navbar_bottom"><!-- --></A>
768 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
769 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
770 <TR>
771 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
772 <A NAME="navbar_bottom_firstrow"><!-- --></A>
773 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
774 <TR ALIGN="center" VALIGN="top">
775 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
776 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
777 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
778 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
779 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
780 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
781 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
782 </TR>
783 </TABLE>
784 </TD>
785 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
786 </EM>
787 </TD>
788 </TR>
790 <TR>
791 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
792 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingListIterator.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
793 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
794 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
795 <A HREF="../../../../index.html?com/google/common/collect/ForwardingMap.html" target="_top"><B>FRAMES</B></A> &nbsp;
796 &nbsp;<A HREF="ForwardingMap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
797 &nbsp;<SCRIPT type="text/javascript">
798 <!--
799 if(window==top) {
800 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
802 //-->
803 </SCRIPT>
804 <NOSCRIPT>
805 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
806 </NOSCRIPT>
809 </FONT></TD>
810 </TR>
811 <TR>
812 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
813 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
814 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
815 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
816 </TR>
817 </TABLE>
818 <A NAME="skip-navbar_bottom"></A>
819 <!-- ======== END OF BOTTOM NAVBAR ======= -->
821 <HR>
823 </BODY>
824 </HTML>