KezvhLib/lib/com.google.com.collect/javadoc/com/google/common/collect/EnumHashBiMap.html

   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 EnumHashBiMap (Google Collections Library - snapshot-20080820 (ALPHA))
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="com.google.common.collect.EnumHashBiMap class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="EnumHashBiMap (Google Collections Library - snapshot-20080820 (ALPHA))";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  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>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../../../com/google/common/collect/EnumBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../../../com/google/common/collect/EnumMultiset.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/EnumHashBiMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="EnumHashBiMap.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>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  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 ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 com.google.common.collect</FONT>
  88 <BR>
  89 Class EnumHashBiMap&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A>&lt;K&gt;,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 "><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingMap</A>&lt;K,V&gt;
  94           <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.EnumHashBiMap&lt;K,V&gt;</B>
  95 </PRE>
  96 <DL>
  97 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;K,V&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A>, <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>
  98 </DL>
  99 <HR>
 100 <DL>
 101 <DT><PRE>public final class <B>EnumHashBiMap&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A>&lt;K&gt;,V&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</DL>
 102 </PRE>
 103
 104 <P>
 105 A <code>BiMap</code> backed by an <code>EnumMap</code> instance for keys-to-values, and
 106  a <code>HashMap</code> instance for values-to-keys. Null keys are not permitted,
 107  but null values are. An <code>EnumHashBiMap</code> and its inverse are both
 108  serializable.
 109 <P>
 110
 111 <P>
 112 <DL>
 113 <DT><B>Author:</B></DT>
 114   <DD>Mike Bostock</DD>
 115 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.EnumHashBiMap">Serialized Form</A></DL>
 116 <HR>
 117
 118 <P>
 119 <!-- ======== NESTED CLASS SUMMARY ======== -->
 120
 121 <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
 126 </TR>
 127 </TABLE>
 128 &nbsp;<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 130 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 131 <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>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <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>
 135 </TR>
 136 </TABLE>
 137 &nbsp;
 138
 139 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 140
 141 <A NAME="constructor_summary"><!-- --></A>
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 144 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 145 <B>Constructor Summary</B></FONT></TH>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#EnumHashBiMap(java.lang.Class)">EnumHashBiMap</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;&nbsp;keyType)</CODE>
 149
 150 <BR>
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new empty bimap using the specified key type, sized to contain
 152  an entry for every possible key.</TD>
 153 </TR>
 154 <TR BGCOLOR="white" CLASS="TableRowColor">
 155 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#EnumHashBiMap(java.util.Map)">EnumHashBiMap</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;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>,? extends <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&gt;&nbsp;map)</CODE>
 156
 157 <BR>
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new bimap with the same mappings as the specified map.</TD>
 159 </TR>
 160 </TABLE>
 161 &nbsp;
 162 <!-- ========== METHOD SUMMARY =========== -->
 163
 164 <A NAME="method_summary"><!-- --></A>
 165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 167 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 168 <B>Method Summary</B></FONT></TH>
 169 </TR>
 170 <TR BGCOLOR="white" CLASS="TableRowColor">
 171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 172 <CODE>&nbsp;void</CODE></FONT></TD>
 173 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#clear()">clear</A></B>()</CODE>
 174
 175 <BR>
 176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all mappings from this map (optional operation).</TD>
 177 </TR>
 178 <TR BGCOLOR="white" CLASS="TableRowColor">
 179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 180 <CODE>&nbsp;boolean</CODE></FONT></TD>
 181 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.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>
 182
 183 <BR>
 184 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map maps one or more keys to the
 185  specified value.</TD>
 186 </TR>
 187 <TR BGCOLOR="white" CLASS="TableRowColor">
 188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 189 <CODE>protected &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;K,V&gt;</CODE></FONT></TD>
 190 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#delegate()">delegate</A></B>()</CODE>
 191
 192 <BR>
 193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backing delegate instance that methods are forwarded to.</TD>
 194 </TR>
 195 <TR BGCOLOR="white" CLASS="TableRowColor">
 196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 197 <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;K,V&gt;&gt;</CODE></FONT></TD>
 198 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#entrySet()">entrySet</A></B>()</CODE>
 199
 200 <BR>
 201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a set view of the mappings contained in this map.</TD>
 202 </TR>
 203 <TR BGCOLOR="white" CLASS="TableRowColor">
 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 205 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A></CODE></FONT></TD>
 206 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#forcePut(K, V)">forcePut</A></B>(<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&nbsp;key,
 207          <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&nbsp;value)</CODE>
 208
 209 <BR>
 210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An alternate form of <code>put</code> that silently removes any existing entry
 211  with the value <code>value</code> before proceeding with the <A HREF="../../../../com/google/common/collect/BiMap.html#put(K, V)"><CODE>BiMap.put(K, V)</CODE></A>
 212  operation.</TD>
 213 </TR>
 214 <TR BGCOLOR="white" CLASS="TableRowColor">
 215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 216 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;V,K&gt;</CODE></FONT></TD>
 217 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#inverse()">inverse</A></B>()</CODE>
 218
 219 <BR>
 220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the inverse view of this bimap, which maps each of this bimap's
 221  values to its associated key.</TD>
 222 </TR>
 223 <TR BGCOLOR="white" CLASS="TableRowColor">
 224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 225 <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;K&gt;</CODE></FONT></TD>
 226 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#keySet()">keySet</A></B>()</CODE>
 227
 228 <BR>
 229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a set view of the keys contained in this map.</TD>
 230 </TR>
 231 <TR BGCOLOR="white" CLASS="TableRowColor">
 232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 233 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;</CODE></FONT></TD>
 234 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#keyType()">keyType</A></B>()</CODE>
 235
 236 <BR>
 237 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the associated key type.</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="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A></CODE></FONT></TD>
 242 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#put(K, V)">put</A></B>(<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&nbsp;key,
 243     <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&nbsp;value)</CODE>
 244
 245 <BR>
 246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Associates the specified value with the specified key in this map
 247  (optional operation).</TD>
 248 </TR>
 249 <TR BGCOLOR="white" CLASS="TableRowColor">
 250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 251 <CODE>&nbsp;void</CODE></FONT></TD>
 252 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.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 K,? extends V&gt;&nbsp;map)</CODE>
 253
 254 <BR>
 255 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies all of the mappings from the specified map to this map
 256  (optional operation).</TD>
 257 </TR>
 258 <TR BGCOLOR="white" CLASS="TableRowColor">
 259 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 260 <CODE>&nbsp;V</CODE></FONT></TD>
 261 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.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;key)</CODE>
 262
 263 <BR>
 264 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the mapping for this key from this map if it is present
 265  (optional operation).</TD>
 266 </TR>
 267 <TR BGCOLOR="white" CLASS="TableRowColor">
 268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 269 <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;V&gt;</CODE></FONT></TD>
 270 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumHashBiMap.html#values()">values</A></B>()</CODE>
 271
 272 <BR>
 273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection view of the values contained in this map.</TD>
 274 </TR>
 275 </TABLE>
 276 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingMap"><!-- --></A>
 277 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 278 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 279 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A></B></TH>
 280 </TR>
 281 <TR BGCOLOR="white" CLASS="TableRowColor">
 282 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#containsKey(java.lang.Object)">containsKey</A>, <A HREF="../../../../com/google/common/collect/ForwardingMap.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../com/google/common/collect/ForwardingMap.html#get(java.lang.Object)">get</A>, <A HREF="../../../../com/google/common/collect/ForwardingMap.html#hashCode()">hashCode</A>, <A HREF="../../../../com/google/common/collect/ForwardingMap.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/ForwardingMap.html#size()">size</A></CODE></TD>
 283 </TR>
 284 </TABLE>
 285 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A>
 286 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 287 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 288 <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>
 289 </TR>
 290 <TR BGCOLOR="white" CLASS="TableRowColor">
 291 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD>
 292 </TR>
 293 </TABLE>
 294 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 295 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 296 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 297 <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>
 298 </TR>
 299 <TR BGCOLOR="white" CLASS="TableRowColor">
 300 <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>
 301 </TR>
 302 </TABLE>
 303 &nbsp;<A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
 304 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 305 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 306 <TH ALIGN="left"><B>Methods 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>
 307 </TR>
 308 <TR BGCOLOR="white" CLASS="TableRowColor">
 309 <TD><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>, <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>, <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>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#hashCode()" title="class or interface in java.util">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#isEmpty()" title="class or interface in java.util">isEmpty</A>, <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></TD>
 310 </TR>
 311 </TABLE>
 312 &nbsp;
 313 <P>
 314
 315 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 316
 317 <A NAME="constructor_detail"><!-- --></A>
 318 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 319 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 320 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 321 <B>Constructor Detail</B></FONT></TH>
 322 </TR>
 323 </TABLE>
 324
 325 <A NAME="EnumHashBiMap(java.lang.Class)"><!-- --></A><H3>
 326 EnumHashBiMap</H3>
 327 <PRE>
 328 public <B>EnumHashBiMap</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;&nbsp;keyType)</PRE>
 329 <DL>
 330 <DD>Constructs a new empty bimap using the specified key type, sized to contain
 331  an entry for every possible key.
 332 <P>
 333 <DL>
 334 <DT><B>Parameters:</B><DD><CODE>keyType</CODE> - the key type</DL>
 335 </DL>
 336 <HR>
 337
 338 <A NAME="EnumHashBiMap(java.util.Map)"><!-- --></A><H3>
 339 EnumHashBiMap</H3>
 340 <PRE>
 341 public <B>EnumHashBiMap</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;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>,? extends <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&gt;&nbsp;map)</PRE>
 342 <DL>
 343 <DD>Constructs a new bimap with the same mappings as the specified map. If the
 344  specified map is an <code>EnumHashBiMap</code> or an <A HREF="../../../../com/google/common/collect/EnumBiMap.html" title="class in com.google.common.collect"><CODE>EnumBiMap</CODE></A>, the new
 345  bimap has the same key type as the input bimap. Otherwise, the specified
 346  map must contain at least one mapping, in order to determine the key type.
 347 <P>
 348 <DL>
 349 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose mappings are to be placed in this map
 350 <DT><B>Throws:</B>
 351 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if map is not an <code>EnumBiMap</code> or an
 352      <code>EnumHashBiMap</code> instance and contains no mappings</DL>
 353 </DL>
 354
 355 <!-- ============ METHOD DETAIL ========== -->
 356
 357 <A NAME="method_detail"><!-- --></A>
 358 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 359 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 360 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 361 <B>Method Detail</B></FONT></TH>
 362 </TR>
 363 </TABLE>
 364
 365 <A NAME="put(java.lang.Enum,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3>
 366 put</H3>
 367 <PRE>
 368 public <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A> <B>put</B>(<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&nbsp;key,
 369              <FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 370              <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&nbsp;value)</PRE>
 371 <DL>
 372 <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>
 373 <DD>Associates the specified value with the specified key in this map
 374  (optional operation).  If the map previously contained a mapping for
 375  this key, the old value is replaced by the specified value.  (A map
 376  <tt>m</tt> is said to contain a mapping for a key <tt>k</tt> if and only
 377  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
 378  <tt>true</tt>.))
 379 <P>
 380 <DD><DL>
 381 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#put(K, V)">put</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A> extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;,<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&gt;</CODE><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/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A> extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;,<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&gt;</CODE></DL>
 382 </DD>
 383 <DD><DL>
 384 <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.
 385 <DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
 386                if there was no mapping for key.  A <tt>null</tt> return can
 387                also indicate that the map previously associated <tt>null</tt>
 388                with the specified key, if the implementation supports
 389                <tt>null</tt> values.</DL>
 390 </DD>
 391 </DL>
 392 <HR>
 393
 394 <A NAME="forcePut(java.lang.Enum,java.lang.Object)"><!-- --></A><A NAME="forcePut(K, V)"><!-- --></A><H3>
 395 forcePut</H3>
 396 <PRE>
 397 public <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A> <B>forcePut</B>(<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&nbsp;key,
 398                   <FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 399                   <A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&nbsp;value)</PRE>
 400 <DL>
 401 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/BiMap.html#forcePut(K, V)">BiMap</A></CODE></B></DD>
 402 <DD>An alternate form of <code>put</code> that silently removes any existing entry
 403  with the value <code>value</code> before proceeding with the <A HREF="../../../../com/google/common/collect/BiMap.html#put(K, V)"><CODE>BiMap.put(K, V)</CODE></A>
 404  operation. If the bimap previously contained the provided key-value
 405  mapping, this method has no effect.
 406
 407  <p>Note that a successful call to this method could cause the size of the
 408  bimap to increase by one, stay the same, or even decrease by one.
 409
 410  <p><b>Warning</b>: If an existing entry with this value is removed, the key
 411  for that entry is discarded and not returned.
 412 <P>
 413 <DD><DL>
 414 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#forcePut(K, V)">forcePut</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A> extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt;,<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">V</A>&gt;</CODE></DL>
 415 </DD>
 416 <DD><DL>
 417 <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key with which the specified value is to be associated<DD><CODE>value</CODE> - the value to be associated with the specified key
 418 <DT><B>Returns:</B><DD>the value which was previously associated with the key, which may
 419      be <code>null</code>, or <code>null</code> if there was no previous entry</DL>
 420 </DD>
 421 </DL>
 422 <HR>
 423
 424 <A NAME="keyType()"><!-- --></A><H3>
 425 keyType</H3>
 426 <PRE>
 427 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&lt;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="type parameter in EnumHashBiMap">K</A>&gt; <B>keyType</B>()</PRE>
 428 <DL>
 429 <DD>Returns the associated key type.
 430 <P>
 431 <DD><DL>
 432 </DL>
 433 </DD>
 434 </DL>
 435 <HR>
 436
 437 <A NAME="delegate()"><!-- --></A><H3>
 438 delegate</H3>
 439 <PRE>
 440 protected <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; <B>delegate</B>()</PRE>
 441 <DL>
 442 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD>
 443 <DD>Returns the backing delegate instance that methods are forwarded to.
 444  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
 445  with an abstract method that has a more specific return type, such as
 446  <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to
 447  supply the instance being decorated.
 448 <P>
 449 <DD><DL>
 450 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 451 </DD>
 452 <DD><DL>
 453 </DL>
 454 </DD>
 455 </DL>
 456 <HR>
 457
 458 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
 459 containsValue</H3>
 460 <PRE>
 461 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>
 462 <DL>
 463 <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>
 464 <DD>Returns <tt>true</tt> if this map maps one or more keys to the
 465  specified value.  More formally, returns <tt>true</tt> if and only if
 466  this map contains at least one mapping to a value <tt>v</tt> such that
 467  <tt>(value==null ? v==null : value.equals(v))</tt>.  This operation
 468  will probably require time linear in the map size for most
 469  implementations of the <tt>Map</tt> interface.
 470 <P>
 471 <DD><DL>
 472 <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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#containsValue(java.lang.Object)">containsValue</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 473 </DD>
 474 <DD><DL>
 475 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value whose presence in this map is to be tested.
 476 <DT><B>Returns:</B><DD><tt>true</tt> if this map maps one or more keys to the
 477          specified value.</DL>
 478 </DD>
 479 </DL>
 480 <HR>
 481
 482 <A NAME="remove(java.lang.Object)"><!-- --></A><H3>
 483 remove</H3>
 484 <PRE>
 485 public V <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;key)</PRE>
 486 <DL>
 487 <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>
 488 <DD>Removes the mapping for this key from this map if it is present
 489  (optional operation).   More formally, if this map contains a mapping
 490  from key <tt>k</tt> to value <tt>v</tt> such that
 491  <code>(key==null ?  k==null : key.equals(k))</code>, that mapping
 492  is removed.  (The map can contain at most one such mapping.)
 493
 494  <p>Returns the value to which the map previously associated the key, or
 495  <tt>null</tt> if the map contained no mapping for this key.  (A
 496  <tt>null</tt> return can also indicate that the map previously
 497  associated <tt>null</tt> with the specified key if the implementation
 498  supports <tt>null</tt> values.)  The map will not contain a mapping for
 499  the specified  key once the call returns.
 500 <P>
 501 <DD><DL>
 502 <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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#remove(java.lang.Object)">remove</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 503 </DD>
 504 <DD><DL>
 505 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose mapping is to be removed from the map.
 506 <DT><B>Returns:</B><DD>previous value associated with specified key, or <tt>null</tt>
 507                if there was no mapping for key.</DL>
 508 </DD>
 509 </DL>
 510 <HR>
 511
 512 <A NAME="putAll(java.util.Map)"><!-- --></A><H3>
 513 putAll</H3>
 514 <PRE>
 515 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 K,? extends V&gt;&nbsp;map)</PRE>
 516 <DL>
 517 <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>
 518 <DD>Copies all of the mappings from the specified map to this map
 519  (optional operation).  The effect of this call is equivalent to that
 520  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
 521  for each mapping from key <tt>k</tt> to value <tt>v</tt> in the
 522  specified map.  The behavior of this operation is unspecified if the
 523  specified map is modified while the operation is in progress.
 524 <P>
 525 <DD><DL>
 526 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#putAll(java.util.Map)">putAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;K,V&gt;</CODE><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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#putAll(java.util.Map)">putAll</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 527 </DD>
 528 <DD><DL>
 529 <DT><B>Parameters:</B><DD><CODE>map</CODE> - Mappings to be stored in this map.</DL>
 530 </DD>
 531 </DL>
 532 <HR>
 533
 534 <A NAME="clear()"><!-- --></A><H3>
 535 clear</H3>
 536 <PRE>
 537 public void <B>clear</B>()</PRE>
 538 <DL>
 539 <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>
 540 <DD>Removes all mappings from this map (optional operation).
 541 <P>
 542 <DD><DL>
 543 <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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#clear()">clear</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 544 </DD>
 545 <DD><DL>
 546 </DL>
 547 </DD>
 548 </DL>
 549 <HR>
 550
 551 <A NAME="inverse()"><!-- --></A><H3>
 552 inverse</H3>
 553 <PRE>
 554 public <A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;V,K&gt; <B>inverse</B>()</PRE>
 555 <DL>
 556 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/BiMap.html#inverse()">BiMap</A></CODE></B></DD>
 557 <DD>Returns the inverse view of this bimap, which maps each of this bimap's
 558  values to its associated key. The two bimaps are backed by the same data;
 559  any changes to one will appear in the other.
 560
 561  <p><b>Note:</b>There is no guaranteed correspondence between the iteration
 562  order of a bimap and that of its inverse.
 563 <P>
 564 <DD><DL>
 565 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#inverse()">inverse</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;K,V&gt;</CODE></DL>
 566 </DD>
 567 <DD><DL>
 568
 569 <DT><B>Returns:</B><DD>the inverse view of this bimap</DL>
 570 </DD>
 571 </DL>
 572 <HR>
 573
 574 <A NAME="keySet()"><!-- --></A><H3>
 575 keySet</H3>
 576 <PRE>
 577 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;K&gt; <B>keySet</B>()</PRE>
 578 <DL>
 579 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#keySet()">ForwardingMap</A></CODE></B></DD>
 580 <DD>Returns a set view of the keys contained in this map.  The set is
 581  backed by the map, so changes to the map are reflected in the set, and
 582  vice-versa.  If the map is modified while an iteration over the set is
 583  in progress (except through the iterator's own <tt>remove</tt>
 584  operation), the results of the iteration are undefined.  The set
 585  supports element removal, which removes the corresponding mapping from
 586  the map, via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
 587  <tt>removeAll</tt> <tt>retainAll</tt>, and <tt>clear</tt> operations.
 588  It does not support the add or <tt>addAll</tt> operations.
 589
 590  <p>The returned set's <code>removeAll</code> and <code>retainAll</code> methods
 591  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.
 592 <P>
 593 <DD><DL>
 594 <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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#keySet()">keySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 595 </DD>
 596 <DD><DL>
 597
 598 <DT><B>Returns:</B><DD>a set view of the keys contained in this map.</DL>
 599 </DD>
 600 </DL>
 601 <HR>
 602
 603 <A NAME="values()"><!-- --></A><H3>
 604 values</H3>
 605 <PRE>
 606 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;V&gt; <B>values</B>()</PRE>
 607 <DL>
 608 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#values()">ForwardingMap</A></CODE></B></DD>
 609 <DD>Returns a collection view of the values contained in this map.  The
 610  collection is backed by the map, so changes to the map are reflected in
 611  the collection, and vice-versa.  If the map is modified while an
 612  iteration over the collection is in progress (except through the
 613  iterator's own <tt>remove</tt> operation), the results of the
 614  iteration are undefined.  The collection supports element removal,
 615  which removes the corresponding mapping from the map, via the
 616  <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
 617  <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations.
 618  It does not support the add or <tt>addAll</tt> operations.
 619
 620  <p>The returned collection's <code>removeAll</code> and <code>retainAll</code>
 621  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
 622  collection.
 623 <P>
 624 <DD><DL>
 625 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#values()">values</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;K,V&gt;</CODE><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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#values()">values</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 626 </DD>
 627 <DD><DL>
 628
 629 <DT><B>Returns:</B><DD>a collection view of the values contained in this map.</DL>
 630 </DD>
 631 </DL>
 632 <HR>
 633
 634 <A NAME="entrySet()"><!-- --></A><H3>
 635 entrySet</H3>
 636 <PRE>
 637 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;K,V&gt;&gt; <B>entrySet</B>()</PRE>
 638 <DL>
 639 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#entrySet()">ForwardingMap</A></CODE></B></DD>
 640 <DD>Returns a set view of the mappings contained in this map.  Each element
 641  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
 642  map, so changes to the map are reflected in the set, and vice-versa.
 643  If the map is modified while an iteration over the set is in progress
 644  (except through the iterator's own <tt>remove</tt> operation, or through
 645  the <tt>setValue</tt> operation on a map entry returned by the iterator)
 646  the results of the iteration are undefined.  The set supports element
 647  removal, which removes the corresponding mapping from the map, via the
 648  <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>,
 649  <tt>retainAll</tt> and <tt>clear</tt> operations.  It does not support
 650  the <tt>add</tt> or <tt>addAll</tt> operations.
 651
 652  <p>The returned set's <code>removeAll</code> and <code>retainAll</code> methods
 653  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.
 654 <P>
 655 <DD><DL>
 656 <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;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html#entrySet()">entrySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingMap.html" title="class in com.google.common.collect">ForwardingMap</A>&lt;K,V&gt;</CODE></DL>
 657 </DD>
 658 <DD><DL>
 659
 660 <DT><B>Returns:</B><DD>a set view of the mappings contained in this map.</DL>
 661 </DD>
 662 </DL>
 663 <!-- ========= END OF CLASS DATA ========= -->
 664 <HR>
 665
 666
 667 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 668 <A NAME="navbar_bottom"><!-- --></A>
 669 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 670 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 671 <TR>
 672 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 673 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 674 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 675   <TR ALIGN="center" VALIGN="top">
 676   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 677   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 678   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 679   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 680   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 681   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 682   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 683   </TR>
 684 </TABLE>
 685 </TD>
 686 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 687 </EM>
 688 </TD>
 689 </TR>
 690
 691 <TR>
 692 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 693 &nbsp;<A HREF="../../../../com/google/common/collect/EnumBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
 694 &nbsp;<A HREF="../../../../com/google/common/collect/EnumMultiset.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
 695 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 696   <A HREF="../../../../index.html?com/google/common/collect/EnumHashBiMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 697 &nbsp;<A HREF="EnumHashBiMap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 698 &nbsp;<SCRIPT type="text/javascript">
 699   <!--
 700   if(window==top) {
 701     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 702   }
 703   //-->
 704 </SCRIPT>
 705 <NOSCRIPT>
 706   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 707 </NOSCRIPT>
 708
 709
 710 </FONT></TD>
 711 </TR>
 712 <TR>
 713 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 714   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 715 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 716 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 717 </TR>
 718 </TABLE>
 719 <A NAME="skip-navbar_bottom"></A>
 720 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 721
 722 <HR>
 723
 724 </BODY>
 725 </HTML>