KezvhLib/lib/com.google.com.collect/javadoc/com/google/common/collect/ImmutableBiMap.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:45 PDT 2008 -->
   6 <TITLE>
   7 ImmutableBiMap (Google Collections Library - snapshot-20080820 (ALPHA))
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="com.google.common.collect.ImmutableBiMap 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="ImmutableBiMap (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/HashMultiset.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.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/ImmutableBiMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="ImmutableBiMap.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;<A HREF="#nested_class_summary">NESTED</A>&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 ImmutableBiMap&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/ImmutableMap.html" title="class in com.google.common.collect">com.google.common.collect.ImmutableMap</A>&lt;K,V&gt;
  93       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ImmutableBiMap&lt;K,V&gt;</B>
  94 </PRE>
  95 <DL>
  96 <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/concurrent/ConcurrentMap.html" title="class or interface in java.util.concurrent">ConcurrentMap</A>&lt;K,V&gt;, <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 <HR>
  99 <DL>
 100 <DT><PRE>public abstract class <B>ImmutableBiMap&lt;K,V&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;K,V&gt;<DT>implements <A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A>&lt;K,V&gt;</DL>
 101 </PRE>
 102
 103 <P>
 104 An immutable <A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect"><CODE>BiMap</CODE></A> with reliable user-specified iteration order. Does
 105  not permit null keys or values. An <code>ImmutableBiMap</code> and its inverse
 106  have the same iteration ordering.
 107
 108  <p>An instance of <code>ImmutableBiMap</code> contains its own data and will
 109  <i>never</i> change. <code>ImmutableBiMap</code> is convenient for
 110  <code>public static final</code> maps ("constant maps") and also lets you easily
 111  make a "defensive copy" of a bimap provided to your class by a caller.
 112
 113  <p><b>Note</b>: Although this class is not final, it cannot be subclassed as
 114  it has no public or protected constructors. Thus, instances of this class are
 115  guaranteed to be immutable.
 116 <P>
 117
 118 <P>
 119 <DL>
 120 <DT><B>Author:</B></DT>
 121   <DD>Jared Levy</DD>
 122 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableBiMap">Serialized Form</A></DL>
 123 <HR>
 124
 125 <P>
 126 <!-- ======== NESTED CLASS SUMMARY ======== -->
 127
 128 <A NAME="nested_class_summary"><!-- --></A>
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 131 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 132 <B>Nested Class Summary</B></FONT></TH>
 133 </TR>
 134 <TR BGCOLOR="white" CLASS="TableRowColor">
 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 136 <CODE>static&nbsp;class</CODE></FONT></TD>
 137 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="class in com.google.common.collect">ImmutableBiMap.Builder</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="type parameter in ImmutableBiMap.Builder">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="type parameter in ImmutableBiMap.Builder">V</A>&gt;</B></CODE>
 138
 139 <BR>
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A builder for creating immutable bimap instances, especially <code>public
 141  static final</code> bimaps ("constant bimaps").</TD>
 142 </TR>
 143 </TABLE>
 144 &nbsp;<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
 145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 147 <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>
 148 </TR>
 149 <TR BGCOLOR="white" CLASS="TableRowColor">
 150 <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>
 151 </TR>
 152 </TABLE>
 153 &nbsp;
 154
 155 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 156
 157 <A NAME="constructor_summary"><!-- --></A>
 158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 159 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 160 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 161 <B>Constructor Summary</B></FONT></TH>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#ImmutableBiMap()">ImmutableBiMap</A></B>()</CODE>
 165
 166 <BR>
 167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 168 </TR>
 169 </TABLE>
 170 &nbsp;
 171 <!-- ========== METHOD SUMMARY =========== -->
 172
 173 <A NAME="method_summary"><!-- --></A>
 174 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 175 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 176 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 177 <B>Method Summary</B></FONT></TH>
 178 </TR>
 179 <TR BGCOLOR="white" CLASS="TableRowColor">
 180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 181 <CODE>static
 182 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 183 <TR ALIGN="right" VALIGN="">
 184 <TD NOWRAP><FONT SIZE="-1">
 185 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="class in com.google.common.collect">ImmutableBiMap.Builder</A>&lt;K,V&gt;</CODE></FONT></TD>
 186 </TR>
 187 </TABLE>
 188 </CODE></FONT></TD>
 189 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#builder()">builder</A></B>()</CODE>
 190
 191 <BR>
 192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new builder.</TD>
 193 </TR>
 194 <TR BGCOLOR="white" CLASS="TableRowColor">
 195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 196 <CODE>&nbsp;boolean</CODE></FONT></TD>
 197 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.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>
 198
 199 <BR>
 200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map contains a mapping for the specified
 201  key.</TD>
 202 </TR>
 203 <TR BGCOLOR="white" CLASS="TableRowColor">
 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 205 <CODE>&nbsp;boolean</CODE></FONT></TD>
 206 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.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>
 207
 208 <BR>
 209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map maps one or more keys to the
 210  specified value.</TD>
 211 </TR>
 212 <TR BGCOLOR="white" CLASS="TableRowColor">
 213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 214 <CODE>static
 215 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 216 <TR ALIGN="right" VALIGN="">
 217 <TD NOWRAP><FONT SIZE="-1">
 218 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 219 </TR>
 220 </TABLE>
 221 </CODE></FONT></TD>
 222 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#copyOf(java.util.Map)">copyOf</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>
 223
 224 <BR>
 225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable bimap containing the same entries as <code>map</code>.</TD>
 226 </TR>
 227 <TR BGCOLOR="white" CLASS="TableRowColor">
 228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 229 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;&gt;</CODE></FONT></TD>
 230 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#entrySet()">entrySet</A></B>()</CODE>
 231
 232 <BR>
 233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable set of the mappings in this map.</TD>
 234 </TR>
 235 <TR BGCOLOR="white" CLASS="TableRowColor">
 236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 237 <CODE>&nbsp;boolean</CODE></FONT></TD>
 238 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.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;o)</CODE>
 239
 240 <BR>
 241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether some other object is "equal to" this one.</TD>
 242 </TR>
 243 <TR BGCOLOR="white" CLASS="TableRowColor">
 244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 245 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A></CODE></FONT></TD>
 246 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#forcePut(K, V)">forcePut</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&nbsp;key,
 247          <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&nbsp;value)</CODE>
 248
 249 <BR>
 250 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Guaranteed to throw an exception and leave the bimap unmodified.</TD>
 251 </TR>
 252 <TR BGCOLOR="white" CLASS="TableRowColor">
 253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 254 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A></CODE></FONT></TD>
 255 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.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>
 256
 257 <BR>
 258 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value to which this map maps the specified key.</TD>
 259 </TR>
 260 <TR BGCOLOR="white" CLASS="TableRowColor">
 261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 262 <CODE>&nbsp;int</CODE></FONT></TD>
 263 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#hashCode()">hashCode</A></B>()</CODE>
 264
 265 <BR>
 266 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash code value for the object.</TD>
 267 </TR>
 268 <TR BGCOLOR="white" CLASS="TableRowColor">
 269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 270 <CODE>abstract &nbsp;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&gt;</CODE></FONT></TD>
 271 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#inverse()">inverse</A></B>()</CODE>
 272
 273 <BR>
 274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the inverse view of this bimap, which maps each of this bimap's
 275  values to its associated key.</TD>
 276 </TR>
 277 <TR BGCOLOR="white" CLASS="TableRowColor">
 278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 279 <CODE>&nbsp;boolean</CODE></FONT></TD>
 280 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#isEmpty()">isEmpty</A></B>()</CODE>
 281
 282 <BR>
 283 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if this map contains no key-value mappings.</TD>
 284 </TR>
 285 <TR BGCOLOR="white" CLASS="TableRowColor">
 286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 287 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&gt;</CODE></FONT></TD>
 288 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#keySet()">keySet</A></B>()</CODE>
 289
 290 <BR>
 291 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable set of the keys in this map.</TD>
 292 </TR>
 293 <TR BGCOLOR="white" CLASS="TableRowColor">
 294 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 295 <CODE>static
 296 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 297 <TR ALIGN="right" VALIGN="">
 298 <TD NOWRAP><FONT SIZE="-1">
 299 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 300 </TR>
 301 </TABLE>
 302 </CODE></FONT></TD>
 303 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of()">of</A></B>()</CODE>
 304
 305 <BR>
 306 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the empty bimap.</TD>
 307 </TR>
 308 <TR BGCOLOR="white" CLASS="TableRowColor">
 309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 310 <CODE>static
 311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 312 <TR ALIGN="right" VALIGN="">
 313 <TD NOWRAP><FONT SIZE="-1">
 314 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 315 </TR>
 316 </TABLE>
 317 </CODE></FONT></TD>
 318 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V)">of</A></B>(K&nbsp;k1,
 319    V&nbsp;v1)</CODE>
 320
 321 <BR>
 322 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable bimap containing a single entry.</TD>
 323 </TR>
 324 <TR BGCOLOR="white" CLASS="TableRowColor">
 325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 326 <CODE>static
 327 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 328 <TR ALIGN="right" VALIGN="">
 329 <TD NOWRAP><FONT SIZE="-1">
 330 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 331 </TR>
 332 </TABLE>
 333 </CODE></FONT></TD>
 334 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K, V)">of</A></B>(K&nbsp;k1,
 335    V&nbsp;v1,
 336    K&nbsp;k2,
 337    V&nbsp;v2)</CODE>
 338
 339 <BR>
 340 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the given entries, in order.</TD>
 341 </TR>
 342 <TR BGCOLOR="white" CLASS="TableRowColor">
 343 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 344 <CODE>static
 345 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 346 <TR ALIGN="right" VALIGN="">
 347 <TD NOWRAP><FONT SIZE="-1">
 348 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 349 </TR>
 350 </TABLE>
 351 </CODE></FONT></TD>
 352 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
 353    V&nbsp;v1,
 354    K&nbsp;k2,
 355    V&nbsp;v2,
 356    K&nbsp;k3,
 357    V&nbsp;v3)</CODE>
 358
 359 <BR>
 360 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the given entries, in order.</TD>
 361 </TR>
 362 <TR BGCOLOR="white" CLASS="TableRowColor">
 363 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 364 <CODE>static
 365 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 366 <TR ALIGN="right" VALIGN="">
 367 <TD NOWRAP><FONT SIZE="-1">
 368 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 369 </TR>
 370 </TABLE>
 371 </CODE></FONT></TD>
 372 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
 373    V&nbsp;v1,
 374    K&nbsp;k2,
 375    V&nbsp;v2,
 376    K&nbsp;k3,
 377    V&nbsp;v3,
 378    K&nbsp;k4,
 379    V&nbsp;v4)</CODE>
 380
 381 <BR>
 382 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the given entries, in order.</TD>
 383 </TR>
 384 <TR BGCOLOR="white" CLASS="TableRowColor">
 385 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 386 <CODE>static
 387 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
 388 <TR ALIGN="right" VALIGN="">
 389 <TD NOWRAP><FONT SIZE="-1">
 390 <CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt;</CODE></FONT></TD>
 391 </TR>
 392 </TABLE>
 393 </CODE></FONT></TD>
 394 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K, V, K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
 395    V&nbsp;v1,
 396    K&nbsp;k2,
 397    V&nbsp;v2,
 398    K&nbsp;k3,
 399    V&nbsp;v3,
 400    K&nbsp;k4,
 401    V&nbsp;v4,
 402    K&nbsp;k5,
 403    V&nbsp;v5)</CODE>
 404
 405 <BR>
 406 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the given entries, in order.</TD>
 407 </TR>
 408 <TR BGCOLOR="white" CLASS="TableRowColor">
 409 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 410 <CODE>&nbsp;int</CODE></FONT></TD>
 411 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#size()">size</A></B>()</CODE>
 412
 413 <BR>
 414 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of key-value mappings in this map.</TD>
 415 </TR>
 416 <TR BGCOLOR="white" CLASS="TableRowColor">
 417 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 418 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 419 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#toString()">toString</A></B>()</CODE>
 420
 421 <BR>
 422 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of the object.</TD>
 423 </TR>
 424 <TR BGCOLOR="white" CLASS="TableRowColor">
 425 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 426 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></FONT></TD>
 427 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableBiMap.html#values()">values</A></B>()</CODE>
 428
 429 <BR>
 430 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable set of the values in this map.</TD>
 431 </TR>
 432 </TABLE>
 433 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ImmutableMap"><!-- --></A>
 434 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 435 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 436 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A></B></TH>
 437 </TR>
 438 <TR BGCOLOR="white" CLASS="TableRowColor">
 439 <TD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#putAll(java.util.Map)">putAll</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#putIfAbsent(K, V)">putIfAbsent</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#remove(java.lang.Object, java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#replace(K, V)">replace</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#replace(K, V, V)">replace</A></CODE></TD>
 440 </TR>
 441 </TABLE>
 442 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 443 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 444 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 445 <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>
 446 </TR>
 447 <TR BGCOLOR="white" CLASS="TableRowColor">
 448 <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>
 449 </TR>
 450 </TABLE>
 451 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.BiMap"><!-- --></A>
 452 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 453 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 454 <TH ALIGN="left"><B>Methods inherited from interface com.google.common.collect.<A HREF="../../../../com/google/common/collect/BiMap.html" title="interface in com.google.common.collect">BiMap</A></B></TH>
 455 </TR>
 456 <TR BGCOLOR="white" CLASS="TableRowColor">
 457 <TD><CODE><A HREF="../../../../com/google/common/collect/BiMap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/BiMap.html#putAll(java.util.Map)">putAll</A></CODE></TD>
 458 </TR>
 459 </TABLE>
 460 &nbsp;<A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
 461 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 462 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 463 <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>
 464 </TR>
 465 <TR BGCOLOR="white" CLASS="TableRowColor">
 466 <TD><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>, <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></TD>
 467 </TR>
 468 </TABLE>
 469 &nbsp;
 470 <P>
 471
 472 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 473
 474 <A NAME="constructor_detail"><!-- --></A>
 475 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 476 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 477 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 478 <B>Constructor Detail</B></FONT></TH>
 479 </TR>
 480 </TABLE>
 481
 482 <A NAME="ImmutableBiMap()"><!-- --></A><H3>
 483 ImmutableBiMap</H3>
 484 <PRE>
 485 public <B>ImmutableBiMap</B>()</PRE>
 486 <DL>
 487 </DL>
 488
 489 <!-- ============ METHOD DETAIL ========== -->
 490
 491 <A NAME="method_detail"><!-- --></A>
 492 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 493 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 494 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 495 <B>Method Detail</B></FONT></TH>
 496 </TR>
 497 </TABLE>
 498
 499 <A NAME="of()"><!-- --></A><H3>
 500 of</H3>
 501 <PRE>
 502 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>()</PRE>
 503 <DL>
 504 <DD>Returns the empty bimap.
 505 <P>
 506 <DD><DL>
 507 </DL>
 508 </DD>
 509 <DD><DL>
 510 </DL>
 511 </DD>
 512 </DL>
 513 <HR>
 514
 515 <A NAME="of(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V)"><!-- --></A><H3>
 516 of</H3>
 517 <PRE>
 518 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
 519                                            V&nbsp;v1)</PRE>
 520 <DL>
 521 <DD>Returns an immutable bimap containing a single entry.
 522 <P>
 523 <DD><DL>
 524 </DL>
 525 </DD>
 526 <DD><DL>
 527 </DL>
 528 </DD>
 529 </DL>
 530 <HR>
 531
 532 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V)"><!-- --></A><H3>
 533 of</H3>
 534 <PRE>
 535 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
 536                                            V&nbsp;v1,
 537                                            K&nbsp;k2,
 538                                            V&nbsp;v2)</PRE>
 539 <DL>
 540 <DD>Returns an immutable map containing the given entries, in order.
 541 <P>
 542 <DD><DL>
 543 </DL>
 544 </DD>
 545 <DD><DL>
 546
 547 <DT><B>Throws:</B>
 548 <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 duplicate keys or values are added</DL>
 549 </DD>
 550 </DL>
 551 <HR>
 552
 553 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V)"><!-- --></A><H3>
 554 of</H3>
 555 <PRE>
 556 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
 557                                            V&nbsp;v1,
 558                                            K&nbsp;k2,
 559                                            V&nbsp;v2,
 560                                            K&nbsp;k3,
 561                                            V&nbsp;v3)</PRE>
 562 <DL>
 563 <DD>Returns an immutable map containing the given entries, in order.
 564 <P>
 565 <DD><DL>
 566 </DL>
 567 </DD>
 568 <DD><DL>
 569
 570 <DT><B>Throws:</B>
 571 <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 duplicate keys or values are added</DL>
 572 </DD>
 573 </DL>
 574 <HR>
 575
 576 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V)"><!-- --></A><H3>
 577 of</H3>
 578 <PRE>
 579 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
 580                                            V&nbsp;v1,
 581                                            K&nbsp;k2,
 582                                            V&nbsp;v2,
 583                                            K&nbsp;k3,
 584                                            V&nbsp;v3,
 585                                            K&nbsp;k4,
 586                                            V&nbsp;v4)</PRE>
 587 <DL>
 588 <DD>Returns an immutable map containing the given entries, in order.
 589 <P>
 590 <DD><DL>
 591 </DL>
 592 </DD>
 593 <DD><DL>
 594
 595 <DT><B>Throws:</B>
 596 <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 duplicate keys or values are added</DL>
 597 </DD>
 598 </DL>
 599 <HR>
 600
 601 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V, K, V)"><!-- --></A><H3>
 602 of</H3>
 603 <PRE>
 604 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
 605                                            V&nbsp;v1,
 606                                            K&nbsp;k2,
 607                                            V&nbsp;v2,
 608                                            K&nbsp;k3,
 609                                            V&nbsp;v3,
 610                                            K&nbsp;k4,
 611                                            V&nbsp;v4,
 612                                            K&nbsp;k5,
 613                                            V&nbsp;v5)</PRE>
 614 <DL>
 615 <DD>Returns an immutable map containing the given entries, in order.
 616 <P>
 617 <DD><DL>
 618 </DL>
 619 </DD>
 620 <DD><DL>
 621
 622 <DT><B>Throws:</B>
 623 <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 duplicate keys or values are added</DL>
 624 </DD>
 625 </DL>
 626 <HR>
 627
 628 <A NAME="builder()"><!-- --></A><H3>
 629 builder</H3>
 630 <PRE>
 631 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="class in com.google.common.collect">ImmutableBiMap.Builder</A>&lt;K,V&gt; <B>builder</B>()</PRE>
 632 <DL>
 633 <DD>Returns a new builder. The generated builder is equivalent to the builder
 634  created by the <A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="class in com.google.common.collect"><CODE>ImmutableBiMap.Builder</CODE></A> constructor.
 635 <P>
 636 <DD><DL>
 637 </DL>
 638 </DD>
 639 <DD><DL>
 640 </DL>
 641 </DD>
 642 </DL>
 643 <HR>
 644
 645 <A NAME="copyOf(java.util.Map)"><!-- --></A><H3>
 646 copyOf</H3>
 647 <PRE>
 648 public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;K,V&gt; <B>copyOf</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>
 649 <DL>
 650 <DD>Returns an immutable bimap containing the same entries as <code>map</code>. If
 651  <code>map</code> somehow contains entries with duplicate keys (for example, if
 652  it is a <code>SortedMap</code> whose comparator is not <i>consistent with
 653  equals</i>), the results of this method are undefined.
 654
 655  <p><b>Note:</b> If <code>map</code> is an <code>ImmutableBiMap</code>, the given map
 656  itself will be returned.
 657 <P>
 658 <DD><DL>
 659 </DL>
 660 </DD>
 661 <DD><DL>
 662
 663 <DT><B>Throws:</B>
 664 <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 two keys have the same value
 665 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if any key or value in <code>map</code> is null</DL>
 666 </DD>
 667 </DL>
 668 <HR>
 669
 670 <A NAME="inverse()"><!-- --></A><H3>
 671 inverse</H3>
 672 <PRE>
 673 public abstract <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="class in com.google.common.collect">ImmutableBiMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&gt; <B>inverse</B>()</PRE>
 674 <DL>
 675 <DD>Returns the inverse view of this bimap, which maps each of this bimap's
 676  values to its associated key. The two bimaps are backed by the same data;
 677  any changes to one will appear in the other.
 678
 679  <p><b>Note:</b>There is no guaranteed correspondence between the iteration
 680  order of a bimap and that of its inverse.
 681
 682  <p>The inverse of an <code>ImmutableBiMap</code> is another
 683  <code>ImmutableBiMap</code>.
 684 <P>
 685 <DD><DL>
 686 <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;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 687 </DD>
 688 <DD><DL>
 689
 690 <DT><B>Returns:</B><DD>the inverse view of this bimap</DL>
 691 </DD>
 692 </DL>
 693 <HR>
 694
 695 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
 696 containsKey</H3>
 697 <PRE>
 698 public boolean <B>containsKey</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 699                            <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>
 700 <DL>
 701 <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>
 702 <DD>Returns <tt>true</tt> if this map contains a mapping for the specified
 703  key.  More formally, returns <tt>true</tt> if and only if
 704  this map contains a mapping for a key <tt>k</tt> such that
 705  <tt>(key==null ? k==null : key.equals(k))</tt>.  (There can be
 706  at most one such mapping.)
 707 <P>
 708 <DD><DL>
 709 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#containsKey(java.lang.Object)">containsKey</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 710 </DD>
 711 <DD><DL>
 712 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose presence in this map is to be tested.
 713 <DT><B>Returns:</B><DD><tt>true</tt> if this map contains a mapping for the specified
 714          key.</DL>
 715 </DD>
 716 </DL>
 717 <HR>
 718
 719 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
 720 containsValue</H3>
 721 <PRE>
 722 public boolean <B>containsValue</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 723                              <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>
 724 <DL>
 725 <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>
 726 <DD>Returns <tt>true</tt> if this map maps one or more keys to the
 727  specified value.  More formally, returns <tt>true</tt> if and only if
 728  this map contains at least one mapping to a value <tt>v</tt> such that
 729  <tt>(value==null ? v==null : value.equals(v))</tt>.  This operation
 730  will probably require time linear in the map size for most
 731  implementations of the <tt>Map</tt> interface.
 732 <P>
 733 <DD><DL>
 734 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#containsValue(java.lang.Object)">containsValue</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 735 </DD>
 736 <DD><DL>
 737 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value whose presence in this map is to be tested.
 738 <DT><B>Returns:</B><DD><tt>true</tt> if this map maps one or more keys to the
 739          specified value.</DL>
 740 </DD>
 741 </DL>
 742 <HR>
 743
 744 <A NAME="entrySet()"><!-- --></A><H3>
 745 entrySet</H3>
 746 <PRE>
 747 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;&gt; <B>entrySet</B>()</PRE>
 748 <DL>
 749 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#entrySet()">ImmutableMap</A></CODE></B></DD>
 750 <DD>Returns an immutable set of the mappings in this map. The entries are in
 751  the same order as the parameters used to build this map.
 752 <P>
 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#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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#entrySet()">entrySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 755 </DD>
 756 <DD><DL>
 757
 758 <DT><B>Returns:</B><DD>a set view of the mappings contained in this map.</DL>
 759 </DD>
 760 </DL>
 761 <HR>
 762
 763 <A NAME="get(java.lang.Object)"><!-- --></A><H3>
 764 get</H3>
 765 <PRE>
 766 public <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A> <B>get</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 767              <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>
 768 <DL>
 769 <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>
 770 <DD>Returns the value to which this map maps the specified key.  Returns
 771  <tt>null</tt> if the map contains no mapping for this key.  A return
 772  value of <tt>null</tt> does not <i>necessarily</i> indicate that the
 773  map contains no mapping for the key; it's also possible that the map
 774  explicitly maps the key to <tt>null</tt>.  The <tt>containsKey</tt>
 775  operation may be used to distinguish these two cases.
 776
 777  <p>More formally, if this map contains a mapping from a key
 778  <tt>k</tt> to a value <tt>v</tt> such that <tt>(key==null ? k==null :
 779  key.equals(k))</tt>, then this method returns <tt>v</tt>; otherwise
 780  it returns <tt>null</tt>.  (There can be at most one such mapping.)
 781 <P>
 782 <DD><DL>
 783 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#get(java.lang.Object)">get</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 784 </DD>
 785 <DD><DL>
 786 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose associated value is to be returned.
 787 <DT><B>Returns:</B><DD>the value to which this map maps the specified key, or
 788                <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>
 789 </DD>
 790 </DL>
 791 <HR>
 792
 793 <A NAME="keySet()"><!-- --></A><H3>
 794 keySet</H3>
 795 <PRE>
 796 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&gt; <B>keySet</B>()</PRE>
 797 <DL>
 798 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#keySet()">ImmutableMap</A></CODE></B></DD>
 799 <DD>Returns an immutable set of the keys in this map. These keys are in
 800  the same order as the parameters used to build this map.
 801 <P>
 802 <DD><DL>
 803 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#keySet()">keySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 804 </DD>
 805 <DD><DL>
 806
 807 <DT><B>Returns:</B><DD>a set view of the keys contained in this map.</DL>
 808 </DD>
 809 </DL>
 810 <HR>
 811
 812 <A NAME="values()"><!-- --></A><H3>
 813 values</H3>
 814 <PRE>
 815 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt; <B>values</B>()</PRE>
 816 <DL>
 817 <DD>Returns an immutable set of the values in this map. The values are in the
 818  same order as the parameters used to build this map.
 819 <P>
 820 <DD><DL>
 821 <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;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">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#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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#values()">values</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 822 </DD>
 823 <DD><DL>
 824
 825 <DT><B>Returns:</B><DD>a collection view of the values contained in this map.</DL>
 826 </DD>
 827 </DL>
 828 <HR>
 829
 830 <A NAME="forcePut(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="forcePut(K, V)"><!-- --></A><H3>
 831 forcePut</H3>
 832 <PRE>
 833 public <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A> <B>forcePut</B>(<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>&nbsp;key,
 834                   <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&nbsp;value)</PRE>
 835 <DL>
 836 <DD>Guaranteed to throw an exception and leave the bimap unmodified.
 837 <P>
 838 <DD><DL>
 839 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 840 </DD>
 841 <DD><DL>
 842 <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
 843 <DT><B>Returns:</B><DD>the value which was previously associated with the key, which may
 844      be <code>null</code>, or <code>null</code> if there was no previous entry
 845 <DT><B>Throws:</B>
 846 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL>
 847 </DD>
 848 </DL>
 849 <HR>
 850
 851 <A NAME="isEmpty()"><!-- --></A><H3>
 852 isEmpty</H3>
 853 <PRE>
 854 public boolean <B>isEmpty</B>()</PRE>
 855 <DL>
 856 <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>
 857 <DD>Returns <tt>true</tt> if this map contains no key-value mappings.
 858 <P>
 859 <DD><DL>
 860 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 861 </DD>
 862 <DD><DL>
 863
 864 <DT><B>Returns:</B><DD><tt>true</tt> if this map contains no key-value mappings.</DL>
 865 </DD>
 866 </DL>
 867 <HR>
 868
 869 <A NAME="size()"><!-- --></A><H3>
 870 size</H3>
 871 <PRE>
 872 public int <B>size</B>()</PRE>
 873 <DL>
 874 <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>
 875 <DD>Returns the number of key-value mappings in this map.  If the
 876  map contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
 877  <tt>Integer.MAX_VALUE</tt>.
 878 <P>
 879 <DD><DL>
 880 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 881 </DD>
 882 <DD><DL>
 883
 884 <DT><B>Returns:</B><DD>the number of key-value mappings in this map.</DL>
 885 </DD>
 886 </DL>
 887 <HR>
 888
 889 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
 890 equals</H3>
 891 <PRE>
 892 public boolean <B>equals</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
 893                       <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;o)</PRE>
 894 <DL>
 895 <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>
 896 <DD>Indicates whether some other object is "equal to" this one.
 897  <p>
 898  The <code>equals</code> method implements an equivalence relation
 899  on non-null object references:
 900  <ul>
 901  <li>It is <i>reflexive</i>: for any non-null reference value
 902      <code>x</code>, <code>x.equals(x)</code> should return
 903      <code>true</code>.
 904  <li>It is <i>symmetric</i>: for any non-null reference values
 905      <code>x</code> and <code>y</code>, <code>x.equals(y)</code>
 906      should return <code>true</code> if and only if
 907      <code>y.equals(x)</code> returns <code>true</code>.
 908  <li>It is <i>transitive</i>: for any non-null reference values
 909      <code>x</code>, <code>y</code>, and <code>z</code>, if
 910      <code>x.equals(y)</code> returns <code>true</code> and
 911      <code>y.equals(z)</code> returns <code>true</code>, then
 912      <code>x.equals(z)</code> should return <code>true</code>.
 913  <li>It is <i>consistent</i>: for any non-null reference values
 914      <code>x</code> and <code>y</code>, multiple invocations of
 915      <tt>x.equals(y)</tt> consistently return <code>true</code>
 916      or consistently return <code>false</code>, provided no
 917      information used in <code>equals</code> comparisons on the
 918      objects is modified.
 919  <li>For any non-null reference value <code>x</code>,
 920      <code>x.equals(null)</code> should return <code>false</code>.
 921  </ul>
 922  <p>
 923  The <tt>equals</tt> method for class <code>Object</code> implements
 924  the most discriminating possible equivalence relation on objects;
 925  that is, for any non-null reference values <code>x</code> and
 926  <code>y</code>, this method returns <code>true</code> if and only
 927  if <code>x</code> and <code>y</code> refer to the same object
 928  (<code>x == y</code> has the value <code>true</code>).
 929  <p>
 930  Note that it is generally necessary to override the <tt>hashCode</tt>
 931  method whenever this method is overridden, so as to maintain the
 932  general contract for the <tt>hashCode</tt> method, which states
 933  that equal objects must have equal hash codes.
 934 <P>
 935 <DD><DL>
 936 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 937 </DD>
 938 <DD><DL>
 939 <DT><B>Parameters:</B><DD><CODE>o</CODE> - the reference object with which to compare.
 940 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
 941           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>,
 942 <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>
 943 </DD>
 944 </DL>
 945 <HR>
 946
 947 <A NAME="hashCode()"><!-- --></A><H3>
 948 hashCode</H3>
 949 <PRE>
 950 public int <B>hashCode</B>()</PRE>
 951 <DL>
 952 <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>
 953 <DD>Returns a hash code value for the object. This method is
 954  supported for the benefit of hashtables such as those provided by
 955  <code>java.util.Hashtable</code>.
 956  <p>
 957  The general contract of <code>hashCode</code> is:
 958  <ul>
 959  <li>Whenever it is invoked on the same object more than once during
 960      an execution of a Java application, the <tt>hashCode</tt> method
 961      must consistently return the same integer, provided no information
 962      used in <tt>equals</tt> comparisons on the object is modified.
 963      This integer need not remain consistent from one execution of an
 964      application to another execution of the same application.
 965  <li>If two objects are equal according to the <tt>equals(Object)</tt>
 966      method, then calling the <code>hashCode</code> method on each of
 967      the two objects must produce the same integer result.
 968  <li>It is <em>not</em> required that if two objects are unequal
 969      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>
 970      method, then calling the <tt>hashCode</tt> method on each of the
 971      two objects must produce distinct integer results.  However, the
 972      programmer should be aware that producing distinct integer results
 973      for unequal objects may improve the performance of hashtables.
 974  </ul>
 975  <p>
 976  As much as is reasonably practical, the hashCode method defined by
 977  class <tt>Object</tt> does return distinct integers for distinct
 978  objects. (This is typically implemented by converting the internal
 979  address of the object into an integer, but this implementation
 980  technique is not required by the
 981  Java<font size="-2"><sup>TM</sup></font> programming language.)
 982 <P>
 983 <DD><DL>
 984 <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/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
 985 </DD>
 986 <DD><DL>
 987
 988 <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>,
 989 <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>
 990 </DD>
 991 </DL>
 992 <HR>
 993
 994 <A NAME="toString()"><!-- --></A><H3>
 995 toString</H3>
 996 <PRE>
 997 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
 998 <DL>
 999 <DD><B>Description copied from class: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">java.lang.Object</A></CODE></B></DD>
1000 <DD>Returns a string representation of the object. In general, the
1001  <code>toString</code> method returns a string that
1002  "textually represents" this object. The result should
1003  be a concise but informative representation that is easy for a
1004  person to read.
1005  It is recommended that all subclasses override this method.
1006  <p>
1007  The <code>toString</code> method for class <code>Object</code>
1008  returns a string consisting of the name of the class of which the
1009  object is an instance, the at-sign character `<code>@</code>', and
1010  the unsigned hexadecimal representation of the hash code of the
1011  object. In other words, this method returns a string equal to the
1012  value of:
1013  <blockquote>
1014  <pre>
1015  getClass().getName() + '@' + Integer.toHexString(hashCode())
1016  </pre></blockquote>
1017 <P>
1018 <DD><DL>
1019 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableBiMap.html" title="type parameter in ImmutableBiMap">V</A>&gt;</CODE></DL>
1020 </DD>
1021 <DD><DL>
1022
1023 <DT><B>Returns:</B><DD>a string representation of the object.</DL>
1024 </DD>
1025 </DL>
1026 <!-- ========= END OF CLASS DATA ========= -->
1027 <HR>
1028
1029
1030 <!-- ======= START OF BOTTOM NAVBAR ====== -->
1031 <A NAME="navbar_bottom"><!-- --></A>
1032 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1033 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1034 <TR>
1035 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1036 <A NAME="navbar_bottom_firstrow"><!-- --></A>
1037 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1038   <TR ALIGN="center" VALIGN="top">
1039   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1040   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1041   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1042   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1043   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1044   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1045   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1046   </TR>
1047 </TABLE>
1048 </TD>
1049 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1050 </EM>
1051 </TD>
1052 </TR>
1053
1054 <TR>
1055 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1056 &nbsp;<A HREF="../../../../com/google/common/collect/HashMultiset.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
1057 &nbsp;<A HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
1058 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1059   <A HREF="../../../../index.html?com/google/common/collect/ImmutableBiMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1060 &nbsp;<A HREF="ImmutableBiMap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1061 &nbsp;<SCRIPT type="text/javascript">
1062   <!--
1063   if(window==top) {
1064     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1065   }
1066   //-->
1067 </SCRIPT>
1068 <NOSCRIPT>
1069   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1070 </NOSCRIPT>
1071
1072
1073 </FONT></TD>
1074 </TR>
1075 <TR>
1076 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1077   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1078 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1079 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1080 </TR>
1081 </TABLE>
1082 <A NAME="skip-navbar_bottom"></A>
1083 <!-- ======== END OF BOTTOM NAVBAR ======= -->
1084
1085 <HR>
1086
1087 </BODY>
1088 </HTML>