[google-collections commit] r61 - trunk/javadoc/com/google/common/collect
codesite...@google.com
Date: Mon Aug 18 17:20:45 2008
New Revision: 61
Added:
trunk/javadoc/com/google/common/collect/Collections2.html (contents,
props changed)
trunk/javadoc/com/google/common/collect/ImmutableBiMap.Builder.html
(contents, props changed)
trunk/javadoc/com/google/common/collect/ImmutableBiMap.html (contents,
props changed)
trunk/javadoc/com/google/common/collect/ImmutableMultimap.Builder.html
(contents, props changed)
trunk/javadoc/com/google/common/collect/ImmutableMultimap.html
(contents, props changed)
trunk/javadoc/com/google/common/collect/ImmutableMultiset.html
(contents, props changed)
trunk/javadoc/com/google/common/collect/ImmutableSortedSet.Factory.html
(contents, props changed)
trunk/javadoc/com/google/common/collect/Serialization.html (contents,
props changed)
trunk/javadoc/com/google/common/collect/UnmodifiableIterator.html
(contents, props changed)
Log:
Re-add Javadoc for new classes, hopefully with the correct MIME types
Added: trunk/javadoc/com/google/common/collect/Collections2.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/Collections2.html Mon Aug 18
17:20:45 2008
@@ -0,0 +1,335 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:22
GMT-08:00 2008 -->
+<TITLE>
+Collections2 (Google Collections Library - snapshot-20080818 (ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Collections2 (Google Collections Library -
snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ClassToInstanceMap.html"
title="interface in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A HREF="../../../../com/google/common/collect/Comparators.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/Collections2.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="Collections2.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class Collections2</H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.Collections2</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public final class <B>Collections2</B><DT>extends <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></DL>
+</PRE>
+
+<P>
+Provides static methods for working with <code>Collection</code> instances.
+<P>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>Chris Povirk, Mike Bostock, Jared Levy</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><T> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in
java.util">Collection</A><T></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/Collections2.html#filter(java.util.Collection,
com.google.common.base.Predicate)">filter</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in
java.util">Collection</A><T> unfiltered,
+ <A HREF="../../../../com/google/common/base/Predicate.html"
title="interface in com.google.common.base">Predicate</A><? super
T> predicate)</CODE>
+
+<BR>
+ Returns the
elements of <code>unfiltered</code> that satisfy a predicate.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><T> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in
java.util">Collection</A><T></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/Collections2.html#forIterable(java.lang.Iterable)">forIterable</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in
java.lang">Iterable</A><T> iterable)</CODE>
+
+<BR>
+ Returns a
limited <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util"><CODE>Collection</CODE></A> view of
the given <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang"><CODE>Iterable</CODE></A>, or
+ the <code>Iterable</code> itself if it is already a
<code>Collection</code> (in which
+ case the rest of this documentation does not apply).</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="forIterable(java.lang.Iterable)"><!-- --></A><H3>
+forIterable</H3>
+<PRE>
+public static <T> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util">Collection</A><T>
<B>forIterable</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in
java.lang">Iterable</A><T> iterable)</PRE>
+<DL>
+<DD>Returns a limited <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util"><CODE>Collection</CODE></A> view of
the given <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang"><CODE>Iterable</CODE></A>, or
+ the <code>Iterable</code> itself if it is already a
<code>Collection</code> (in which
+ case the rest of this documentation does not apply). The returned
+ collection is not appropriate for general use for a number of reasons.
+ Instead, it exists to provide frequently desired methods for dealing with
+ <code>Iterable</code> objects -- such as
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)"
title="class or interface in
java.util"><CODE>Collection.removeAll(Collection)</CODE></A> -- through the
familiar
+ <code>Collection</code> interface. To treat the contents of an
<code>Iterable</code>
+ as a full-fledged, performant <code>Collection</code>, it is recommended
that
+ clients call a method like <A
HREF="../../../../com/google/common/collect/ImmutableSet.html#copyOf(java.lang.Iterable)"><CODE>ImmutableSet.copyOf(Iterable)</CODE></A>
or
+ <A
HREF="../../../../com/google/common/collect/Iterables.html#addAll(java.util.Collection,
java.lang.Iterable)"><CODE>Iterables.addAll(Collection,
Iterable)</CODE></A> to dump the contents of the
+ <code>Iterable</code> into a standard <code>Collection</code>. For cases
in which a
+ view of the <code>Iterable</code> is required, <code>forIterable()</code>
is
+ available.
+
+ <p>A number of limitations result from building on the
<code>Iterable</code>
+ interface. Notably, <code>size()</code>, <code>contains()</code>, and
many other
+ methods of the returned collection are O(n). The returned collection does
+ not support the insertion of items. Removal of elements is supported if
the
+ underlying <code>Iterable</code> supports it, and all non-mutative
operations
+ are supported. Additionally, each method call on the returned collection
+ calls <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()"
title="class or interface in
java.lang"><CODE>Iterable.iterator()</CODE></A> on the source
<code>Iterable</code>. Thus, if
+ you wish to call more than one method on the collection or to otherwise
+ access the contents of the <code>Iterable</code> after calling a method,
the
+ <code>Iterable</code> must support the creation of multiple iterators.
+
+ <p><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in
java.lang"><CODE>Object.equals(Object)</CODE></A> and <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang"><CODE>Object.hashCode()</CODE></A>
are inherited from
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang"><CODE>Object</CODE></A>, as the
returned <code>Collection</code> is not an implementation
+ of any additional interface, such as <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util"><CODE>List</CODE></A> or
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true"
title="class or interface in java.util"><CODE>Set</CODE></A>.
+
+ <p>The behavior of the returned collection's iterator in the face of
+ concurrent structural modification of the returned collection or of the
+ underlying <code>Iterable</code> is undefined, and no guarantee is made
that the
+ objects are fail-fast.
+
+ <p><b>Usage Example</b>
+
+ <pre>
+ // Remove all instances of "foo" from an Iterable:
+ Collections2.forIterable(iterable).removeAll(ImmutableSet.of("foo"));
+ </pre>
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="filter(java.util.Collection,
com.google.common.base.Predicate)"><!-- --></A><H3>
+filter</H3>
+<PRE>
+public static <T> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util">Collection</A><T>
<B>filter</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in
java.util">Collection</A><T> unfiltered,
+ <A
HREF="../../../../com/google/common/base/Predicate.html" title="interface
in com.google.common.base">Predicate</A><? super
T> predicate)</PRE>
+<DL>
+<DD>Returns the elements of <code>unfiltered</code> that satisfy a
predicate. The
+ returned collection is a live view of <code>unfiltered</code>; changes to
one
+ affect the other.
+
+ <p>The resulting collection's iterator does not support
<code>remove()</code>,
+ but all other collection methods are supported. The collection's
+ <code>add()</code> and <code>addAll()</code> methods throw an
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in
java.lang"><CODE>IllegalArgumentException</CODE></A> if an element that
doesn't satisfy the
+ predicate is provided. When methods such as <code>removeAll()</code> and
+ <code>clear()</code> are called on the filtered collection, only elements
that
+ satisfy the filter will be removed from the underlying collection.
+
+ <p>The returned collection isn't threadsafe or serializable, even if
+ <code>unfiltered</code> is.
+
+ <p>Many of the filtered collection's methods, such as <code>size()</code>,
+ iterate across every element in the underlying collection and determine
+ which elements satisfy the filter. When a live view is <i>not</i> needed,
+ it may be faster to copy the filtered collection and use the copy.
+
+ <p>The <code>clear()</code>, <code>removeAll()</code>, and
<code>retainAll()</code>
+ methods all call <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#remove()"
title="class or interface in java.util"><CODE>Iterator.remove()</CODE></A>
on the underlying collection's
+ iterator. Consequently, methods like the following throw an
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang"><CODE>UnsupportedOperationException</CODE></A>.
+ <pre> Collections2.filter(Collections2.filter(collection, predicate1),
+ predicate2)).clear();</pre>
+ Instead, call
+ <A
HREF="../../../../com/google/common/base/Predicates.html#and(com.google.common.base.Predicate,
com.google.common.base.Predicate)"><CODE>Predicates.and(Predicate,
Predicate)</CODE></A> to
+ combine the predicates and pass the combined predicate to this method.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ClassToInstanceMap.html"
title="interface in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A HREF="../../../../com/google/common/collect/Comparators.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/Collections2.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="Collections2.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Added: trunk/javadoc/com/google/common/collect/ImmutableBiMap.Builder.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/ImmutableBiMap.Builder.html Mon
Aug 18 17:20:45 2008
@@ -0,0 +1,336 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:23
GMT-08:00 2008 -->
+<TITLE>
+ImmutableBiMap.Builder (Google Collections Library - snapshot-20080818
(ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ImmutableBiMap.Builder (Google Collections
Library - snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableBiMap.Builder.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableBiMap.Builder.html" target="_top"><B>NO
FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A
HREF="#constructor_summary">CONSTR</A> | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class ImmutableBiMap.Builder<K,V></H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in
com.google.common.collect">com.google.common.collect.ImmutableMap.Builder</A><K,V>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.ImmutableBiMap.Builder<K,V></B>
+</PRE>
+<DL>
+<DT><B>Enclosing class:</B><DD><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><<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>></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public static final class
<B>ImmutableBiMap.Builder<K,V></B><DT>extends <A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in
com.google.common.collect">ImmutableMap.Builder</A><K,V></DL>
+</PRE>
+
+<P>
+A builder for creating immutable bimap instances, especially <code>public
+ static final</code> bimaps ("constant bimaps"). Example: <pre>
<code>static final ImmutableBiMap<String, Integer> WORD_TO_INT =
+ new ImmutableBiMap.Builder<String, Integer>()
+ .put("one", 1)
+ .put("two", 2)
+ .put("three", 3)
+ .build();</code></pre>
+
+ For <i>small</i> immutable bimaps, the <code>ImmutableBiMap.of()</code>
methods
+ are even more convenient.
+
+ <p>Builder instances can be reused - it is safe to call <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#build()"><CODE>build()</CODE></A>
+ multiple times to build multiple bimaps in series. Each bimap is a
superset
+ of the bimaps created before it.
+<P>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#ImmutableBiMap.Builder()">ImmutableBiMap.Builder</A></B>()</CODE>
+
+<BR>
+ Creates a new
builder.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><<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>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#build()">build</A></B>()</CODE>
+
+<BR>
+ Returns a
newly-created immutable bimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect">ImmutableBiMap.Builder</A><<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>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#put(K,
V)">put</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">V</A> value)</CODE>
+
+<BR>
+ Associates
<code>key</code> with <code>value</code> in the built bimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect">ImmutableBiMap.Builder</A><<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>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#putAll(java.util.Map)">putAll</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">K</A>,? extends <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">V</A>> map)</CODE>
+
+<BR>
+ Associates all
of <code>map's</code> keys and values in the built bimap.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="ImmutableBiMap.Builder()"><!-- --></A><H3>
+ImmutableBiMap.Builder</H3>
+<PRE>
+public <B>ImmutableBiMap.Builder</B>()</PRE>
+<DL>
+<DD>Creates a new builder. The returned builder is equivalent to the
builder
+ generated by <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#builder()"><CODE>ImmutableBiMap.builder()</CODE></A>.
+<P>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A
NAME="put(K, V)"><!-- --></A><H3>
+put</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect">ImmutableBiMap.Builder</A><<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>> <B>put</B>(<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">V</A> value)</PRE>
+<DL>
+<DD>Associates <code>key</code> with <code>value</code> in the built
bimap. Duplicate
+ keys or values are not allowed, and will cause <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#build()"><CODE>build()</CODE></A>
to fail.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html#put(K,
V)">put</A></CODE> in class <CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in com.google.common.collect">ImmutableMap.Builder</A><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="putAll(java.util.Map)"><!-- --></A><H3>
+putAll</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect">ImmutableBiMap.Builder</A><<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>> <B>putAll</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">K</A>,? extends <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="type parameter in ImmutableBiMap.Builder">V</A>> map)</PRE>
+<DL>
+<DD>Associates all of <code>map's</code> keys and values in the built
bimap.
+ Duplicate keys or values are not allowed, and will cause <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html#build()"><CODE>build()</CODE></A>
+ to fail.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html#putAll(java.util.Map)">putAll</A></CODE>
in class <CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in com.google.common.collect">ImmutableMap.Builder</A><<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>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true"
title="class or interface in java.lang">NullPointerException</A></CODE> -
if any key or value in <code>map</code> is null</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="build()"><!-- --></A><H3>
+build</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><<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>>
<B>build</B>()</PRE>
+<DL>
+<DD>Returns a newly-created immutable bimap.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html#build()">build</A></CODE>
in class <CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in com.google.common.collect">ImmutableMap.Builder</A><<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>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if duplicate keys or values were added</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableBiMap.Builder.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableBiMap.Builder.html" target="_top"><B>NO
FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A
HREF="#constructor_summary">CONSTR</A> | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Added: trunk/javadoc/com/google/common/collect/ImmutableBiMap.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/ImmutableBiMap.html Mon Aug 18
17:20:45 2008
@@ -0,0 +1,946 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:23
GMT-08:00 2008 -->
+<TITLE>
+ImmutableBiMap (Google Collections Library - snapshot-20080818 (ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ImmutableBiMap (Google Collections Library
- snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../com/google/common/collect/HashMultiset.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableBiMap.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableBiMap.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> |
FIELD | <A HREF="#constructor_summary">CONSTR</A> |
<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class ImmutableBiMap<K,V></H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <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><K,V>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.ImmutableBiMap<K,V></B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A
HREF="../../../../com/google/common/collect/BiMap.html" title="interface in
com.google.common.collect">BiMap</A><K,V>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"
title="class or interface in java.io">Serializable</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true"
title="class or interface in
java.util.concurrent">ConcurrentMap</A><K,V>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</A><K,V></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public abstract class <B>ImmutableBiMap<K,V></B><DT>extends
<A HREF="../../../../com/google/common/collect/ImmutableMap.html"
title="class in
com.google.common.collect">ImmutableMap</A><K,V><DT>implements <A
HREF="../../../../com/google/common/collect/BiMap.html" title="interface in
com.google.common.collect">BiMap</A><K,V></DL>
+</PRE>
+
+<P>
+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
+ not permit null keys or values. An <code>ImmutableBiMap</code> and its
inverse
+ have the same iteration ordering.
+
+ <p>An instance of <code>ImmutableBiMap</code> contains its own data and
will
+ <i>never</i> change. <code>ImmutableBiMap</code> is convenient for
+ <code>public static final</code> maps ("constant maps") and also lets you
easily
+ make a "defensive copy" of a bimap provided to your class by a caller.
+
+ <p><b>Note</b>: Although this class is not final, it cannot be subclassed
as
+ it has no public or protected constructors. Thus, instances of this class
are
+ guaranteed to be immutable.
+<P>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>Jared Levy</DD>
+<DT><B>See Also:</B><DD><A
HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableBiMap">Serialized
Form</A></DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+<A NAME="nested_class_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static class</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect">ImmutableBiMap.Builder</A><<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>></B></CODE>
+
+<BR>
+ A builder for
creating immutable bimap instances, especially <code>public
+ static final</code> bimaps ("constant bimaps").</TD>
+</TR>
+</TABLE>
+ <A NAME="nested_classes_inherited_from_class_java.util.Map"><!--
--></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<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?is-external=true"
title="class or interface in java.util">Map</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">Map.Entry</A><<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">K</A>,<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">V</A>></CODE></TD>
+</TR>
+</TABLE>
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#ImmutableBiMap()">ImmutableBiMap</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in
com.google.common.collect">ImmutableBiMap.Builder</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#builder()">builder</A></B>()</CODE>
+
+<BR>
+ Returns a new
builder.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<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?is-external=true"
title="class or interface in java.lang">Object</A> key)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<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?is-external=true"
title="class or interface in java.lang">Object</A> value)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<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?is-external=true"
title="class or interface in java.util">Map</A><? extends K,? extends
V> map)</CODE>
+
+<BR>
+ Returns an
immutable bimap containing the same entries as <code>map</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class
in com.google.common.collect">ImmutableSet</A><<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">Map.Entry</A><<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>>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#entrySet()">entrySet</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable set of the mappings in this map.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<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?is-external=true"
title="class or interface in java.lang">Object</A> o)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A></CODE></FONT></TD>
+<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> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A> value)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the bimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A></CODE></FONT></TD>
+<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?is-external=true"
title="class or interface in java.lang">Object</A> key)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>abstract <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><<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>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#inverse()">inverse</A></B>()</CODE>
+
+<BR>
+ Returns the
inverse view of this bimap, which maps each of this bimap's
+ values to its associated key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#isEmpty()">isEmpty</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class
in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">K</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#keySet()">keySet</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable set of the keys in this map.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of()">of</A></B>()</CODE>
+
+<BR>
+ Returns the
empty bimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K,
V)">of</A></B>(K k1,
+ V v1)</CODE>
+
+<BR>
+ Returns an
immutable bimap containing a single entry.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K,
V)">of</A></B>(K k1,
+ V v1,
+ K k2,
+ V v2)</CODE>
+
+<BR>
+ Returns an
immutable map containing the given entries, in order.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K,
V, K, V)">of</A></B>(K k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3)</CODE>
+
+<BR>
+ Returns an
immutable map containing the given entries, in order.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#of(K, V, K,
V, K, V, K, V)">of</A></B>(K k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3,
+ K k4,
+ V v4)</CODE>
+
+<BR>
+ Returns an
immutable map containing the given entries, in order.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in
com.google.common.collect">ImmutableBiMap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<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 k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3,
+ K k4,
+ V v4,
+ K k5,
+ V v5)</CODE>
+
+<BR>
+ Returns an
immutable map containing the given entries, in order.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#size()">size</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class
in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html#values()">values</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable set of the values in this map.</TD>
+</TR>
+</TABLE>
+ <A
NAME="methods_inherited_from_class_com.google.common.collect.ImmutableMap"><!--
--></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<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>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+ <A
NAME="methods_inherited_from_class_com.google.common.collect.BiMap"><!--
--></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<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>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from interface java.util.<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#clear()"
title="class or interface in java.util">clear</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)"
title="class or interface in java.util">remove</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="ImmutableBiMap()"><!-- --></A><H3>
+ImmutableBiMap</H3>
+<PRE>
+public <B>ImmutableBiMap</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="of()"><!-- --></A><H3>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>()</PRE>
+<DL>
+<DD>Returns the empty bimap.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="of(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K,
V)"><!-- --></A><H3>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>(K k1,
+ V v1)</PRE>
+<DL>
+<DD>Returns an immutable bimap containing a single entry.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<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>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>(K k1,
+ V v1,
+ K k2,
+ V v2)</PRE>
+<DL>
+<DD>Returns an immutable map containing the given entries, in order.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if duplicate keys or values are added</DL>
+</DD>
+</DL>
+<HR>
+
+<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>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>(K k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3)</PRE>
+<DL>
+<DD>Returns an immutable map containing the given entries, in order.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if duplicate keys or values are added</DL>
+</DD>
+</DL>
+<HR>
+
+<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>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>(K k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3,
+ K k4,
+ V v4)</PRE>
+<DL>
+<DD>Returns an immutable map containing the given entries, in order.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if duplicate keys or values are added</DL>
+</DD>
+</DL>
+<HR>
+
+<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>
+of</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>of</B>(K k1,
+ V v1,
+ K k2,
+ V v2,
+ K k3,
+ V v3,
+ K k4,
+ V v4,
+ K k5,
+ V v5)</PRE>
+<DL>
+<DD>Returns an immutable map containing the given entries, in order.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if duplicate keys or values are added</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="builder()"><!-- --></A><H3>
+builder</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in
com.google.common.collect">ImmutableBiMap.Builder</A><K,V>
<B>builder</B>()</PRE>
+<DL>
+<DD>Returns a new builder. The generated builder is equivalent to the
builder
+ 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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="copyOf(java.util.Map)"><!-- --></A><H3>
+copyOf</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><K,V>
<B>copyOf</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true"
title="class or interface in java.util">Map</A><? extends K,? extends
V> map)</PRE>
+<DL>
+<DD>Returns an immutable bimap containing the same entries as
<code>map</code>. If
+ <code>map</code> somehow contains entries with duplicate keys (for
example, if
+ it is a <code>SortedMap</code> whose comparator is not <i>consistent with
+ equals</i>), the results of this method are undefined.
+
+ <p><b>Note:</b> If <code>map</code> is an <code>ImmutableBiMap</code>,
the given map
+ itself will be returned.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"
title="class or interface in java.lang">IllegalArgumentException</A></CODE>
- if two keys have the same value
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true"
title="class or interface in java.lang">NullPointerException</A></CODE> -
if any key or value in <code>map</code> is null</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="inverse()"><!-- --></A><H3>
+inverse</H3>
+<PRE>
+public abstract <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="class in com.google.common.collect">ImmutableBiMap</A><<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>> <B>inverse</B>()</PRE>
+<DL>
+<DD>Returns the inverse view of this bimap, which maps each of this bimap's
+ values to its associated key. The two bimaps are backed by the same data;
+ any changes to one will appear in the other.
+
+ <p><b>Note:</b>There is no guaranteed correspondence between the iteration
+ order of a bimap and that of its inverse.
+
+ <p>The inverse of an <code>ImmutableBiMap</code> is another
+ <code>ImmutableBiMap</code>.
+<P>
+<DD><DL>
+<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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the inverse view of this bimap</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
+containsKey</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
+containsValue</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="entrySet()"><!-- --></A><H3>
+entrySet</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableSet.html"
title="class in com.google.common.collect">ImmutableSet</A><<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">Map.Entry</A><<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>>>
<B>entrySet</B>()</PRE>
+<DL>
+<DD><B>Description copied from class: <CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.html#entrySet()">ImmutableMap</A></CODE></B></DD>
+<DD>Returns an immutable set of the mappings in this map. The entries are
in
+ the same order as the parameters used to build this map.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="get(java.lang.Object)"><!-- --></A><H3>
+get</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="keySet()"><!-- --></A><H3>
+keySet</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableSet.html"
title="class in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">K</A>> <B>keySet</B>()</PRE>
+<DL>
+<DD><B>Description copied from class: <CODE><A
HREF="../../../../com/google/common/collect/ImmutableMap.html#keySet()">ImmutableMap</A></CODE></B></DD>
+<DD>Returns an immutable set of the keys in this map. These keys are in
+ the same order as the parameters used to build this map.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="values()"><!-- --></A><H3>
+values</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableSet.html"
title="class in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A>> <B>values</B>()</PRE>
+<DL>
+<DD>Returns an immutable set of the values in this map. The values are in
the
+ same order as the parameters used to build this map.
+<P>
+<DD><DL>
+<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><<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>></CODE><DT><B>Specified
by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="forcePut(java.lang.Object,java.lang.Object)"><!-- --></A><A
NAME="forcePut(K, V)"><!-- --></A><H3>
+forcePut</H3>
+<PRE>
+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> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.html"
title="type parameter in ImmutableBiMap">V</A> value)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the bimap unmodified.
+<P>
+<DD><DL>
+<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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+<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
+<DT><B>Returns:</B><DD>the value which was previously associated with the
key, which may
+ be <code>null</code>, or <code>null</code> if there was no previous
entry
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isEmpty()"><!-- --></A><H3>
+isEmpty</H3>
+<PRE>
+public boolean <B>isEmpty</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="size()"><!-- --></A><H3>
+size</H3>
+<PRE>
+public int <B>size</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> o)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</H3>
+<PRE>
+public int <B>hashCode</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#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?is-external=true"
title="class or interface in java.util">Map</A><<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>></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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
+<DL>
+<DD><DL>
+<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><<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>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../com/google/common/collect/HashMultiset.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableBiMap.Builder.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableBiMap.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableBiMap.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> |
FIELD | <A HREF="#constructor_summary">CONSTR</A> |
<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Added:
trunk/javadoc/com/google/common/collect/ImmutableMultimap.Builder.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/ImmutableMultimap.Builder.html
Mon Aug 18 17:20:45 2008
@@ -0,0 +1,347 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:23
GMT-08:00 2008 -->
+<TITLE>
+ImmutableMultimap.Builder (Google Collections Library - snapshot-20080818
(ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ImmutableMultimap.Builder (Google
Collections Library - snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableMultimap.Builder.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableMultimap.Builder.html" target="_top"><B>NO
FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A
HREF="#constructor_summary">CONSTR</A> | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class ImmutableMultimap.Builder<K,V></H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.ImmutableMultimap.Builder<K,V></B>
+</PRE>
+<DL>
+<DT><B>Enclosing class:</B><DD><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect">ImmutableMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public static class
<B>ImmutableMultimap.Builder<K,V></B><DT>extends <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></DL>
+</PRE>
+
+<P>
+A builder for creating immutable multimap instances, especially
+ <code>public static final</code> multimaps ("constant multimaps").
Example:
+ <pre> <code>static final Multimap<String,Integer>
STRING_TO_INTEGER_MULTIMAP =
+ new ImmutableMultimap.Builder<String, Integer>()
+ .put("one", 1)
+ .putAll("several", 1, 2, 3)
+ .putAll("many", 1, 2, 3, 4, 5)
+ .build();</code></pre>
+
+ <p>Builder instances can be reused - it is safe to call <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#build()"><CODE>build()</CODE></A>
+ multiple times to build multiple multimaps in series. Each multimap
+ contains the key-value mappings in the previously created multimaps.
+<P>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#ImmutableMultimap.Builder()">ImmutableMultimap.Builder</A></B>()</CODE>
+
+<BR>
+ Creates a new
builder.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect">ImmutableMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#build()">build</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#put(K,
V)">put</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A> value)</CODE>
+
+<BR>
+ Adds a
key-value mapping to the built multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#putAll(K,
java.lang.Iterable)">putAll</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>> values)</CODE>
+
+<BR>
+ Stores a
collection of values with the same key in the built multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html#putAll(K,
V...)">putAll</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>... values)</CODE>
+
+<BR>
+ Stores an
array of values with the same key in the built multimap.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="ImmutableMultimap.Builder()"><!-- --></A><H3>
+ImmutableMultimap.Builder</H3>
+<PRE>
+public <B>ImmutableMultimap.Builder</B>()</PRE>
+<DL>
+<DD>Creates a new builder. The returned builder is equivalent to the
builder
+ generated by <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#builder()"><CODE>ImmutableMultimap.builder()</CODE></A>.
+<P>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A
NAME="put(K, V)"><!-- --></A><H3>
+put</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A>> <B>put</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A> value)</PRE>
+<DL>
+<DD>Adds a key-value mapping to the built multimap.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A
NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3>
+putAll</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A>>
<B>putAll</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>> values)</PRE>
+<DL>
+<DD>Stores a collection of values with the same key in the built multimap.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true"
title="class or interface in java.lang">NullPointerException</A></CODE> -
if <code>key</code>, <code>values</code>, or any
+ element in <code>values</code> is null. The builder is left in an
invalid
+ state.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="putAll(java.lang.Object,java.lang.Object[])"><!-- --></A><A
NAME="putAll(K, V...)"><!-- --></A><H3>
+putAll</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A>>
<B>putAll</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in
ImmutableMultimap.Builder">V</A>... values)</PRE>
+<DL>
+<DD>Stores an array of values with the same key in the built multimap.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true"
title="class or interface in java.lang">NullPointerException</A></CODE> -
if the key or any value is null. If a later
+ value is null, earlier values may be added to the builder.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="build()"><!-- --></A><H3>
+build</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect">ImmutableMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A>>
<B>build</B>()</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableMultimap.Builder.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableMultimap.Builder.html" target="_top"><B>NO
FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A
HREF="#constructor_summary">CONSTR</A> | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A
HREF="#constructor_detail">CONSTR</A> | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Added: trunk/javadoc/com/google/common/collect/ImmutableMultimap.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/ImmutableMultimap.html Mon Aug
18 17:20:45 2008
@@ -0,0 +1,931 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:23
GMT-08:00 2008 -->
+<TITLE>
+ImmutableMultimap (Google Collections Library - snapshot-20080818 (ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ImmutableMultimap (Google Collections
Library - snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableMultimap.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableMultimap.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> |
FIELD | CONSTR | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class ImmutableMultimap<K,V></H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.ImmutableMultimap<K,V></B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><K,V>,
<A HREF="../../../../com/google/common/collect/Multimap.html"
title="interface in com.google.common.collect">Multimap</A><K,V>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"
title="class or interface in java.io">Serializable</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>ImmutableMultimap<K,V></B><DT>extends <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A><DT>implements <A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><K,V>,
<A
HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"
title="class or interface in java.io">Serializable</A></DL>
+</PRE>
+
+<P>
+An immutable <A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in
com.google.common.collect"><CODE>ListMultimap</CODE></A> with reliable
user-specified key and value
+ iteration order. Does not permit null keys or values.
+
+ <p>Unlike <A
HREF="../../../../com/google/common/collect/Multimaps.html#unmodifiableListMultimap(com.google.common.collect.ListMultimap)"><CODE>Multimaps.unmodifiableListMultimap(ListMultimap)</CODE></A>,
which is
+ a <i>view</i> of a separate map which can still change, an instance of
+ <code>ImmutableMultimap</code> contains its own data and will
<i>never</i> change.
+ <code>ImmutableMultimap</code> is convenient for <code>public static
final</code>
+ multimaps ("constant multimaps") and also lets you easily make
a "defensive
+ copy" of a multimap provided to your class by a caller.
+
+ <p><b>Note</b>: Although this class is not final, it cannot be subclassed
as
+ it has no public or protected constructors. Thus, instances of this class
are
+ guaranteed to be immutable.
+<P>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>Jared Levy</DD>
+<DT><B>See Also:</B><DD><A
HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableMultimap">Serialized
Form</A></DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+<A NAME="nested_class_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static class</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="type parameter in ImmutableMultimap.Builder">V</A>></B></CODE>
+
+<BR>
+ A builder for
creating immutable multimap instances, especially
+ <code>public static final</code> multimaps ("constant multimaps").</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class
in com.google.common.collect">ImmutableMap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util">Collection</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#asMap()">asMap</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable map that associates each key with its corresponding
+ values in the multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#builder()">builder</A></B>()</CODE>
+
+<BR>
+ Returns a new
builder.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#clear()">clear</A></B>()</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsEntry(java.lang.Object,
java.lang.Object)">containsEntry</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</CODE>
+
+<BR>
+ Returns
<code>true</code> if the multimap contains the specified key-value
pair.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsKey(java.lang.Object)">containsKey</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</CODE>
+
+<BR>
+ Returns
<code>true</code> if the multimap contains any values for the specified
+ key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsValue(java.lang.Object)">containsValue</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</CODE>
+
+<BR>
+ Returns
<code>true</code> if the multimap contains the specified value for any
+ key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in
com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#copyOf(com.google.common.collect.Multimap)">copyOf</A></B>(<A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><? extends K,? extends
V> multimap)</CODE>
+
+<BR>
+ Returns an
immutable multimap containing the same mappings as
+ <code>multimap</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in
com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#empty()">empty</A></B>()</CODE>
+
+<BR>
+ Returns the
empty multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect">ImmutableCollection</A><<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">Map.Entry</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#entries()">entries</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable collection of all key-value pairs in the multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#equals(java.lang.Object)">equals</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> obj)</CODE>
+
+<BR>
+ Compares the
specified object to this multimap for equality.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableList.html"
title="class in com.google.common.collect">ImmutableList</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#get(K)">get</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key)</CODE>
+
+<BR>
+ Returns an
immutable list of the values for the given key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+ Returns the
hash code for this multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#isEmpty()">isEmpty</A></B>()</CODE>
+
+<BR>
+ Returns
<code>true</code> if the multimap contains no key-value pairs.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in com.google.common.collect">ImmutableMultiset</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keys()">keys</A></B>()</CODE>
+
+<BR>
+ Returns a
collection, which may contain duplicates, of all keys.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class
in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keySet()">keySet</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable set of the distinct keys in this multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#put(K,
V)">put</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A> value)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#putAll(K,
java.lang.Iterable)">putAll</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> values)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></B>(<A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> multimap)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#remove(java.lang.Object,
java.lang.Object)">remove</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#removeAll(java.lang.Object)">removeAll</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#replaceValues(K,
java.lang.Iterable)">replaceValues</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> values)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the multimap unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#size()">size</A></B>()</CODE>
+
+<BR>
+ Returns the
number of key-value pairs in the multimap.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect">ImmutableCollection</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html#values()">values</A></B>()</CODE>
+
+<BR>
+ Returns an
immutable collection of the values in this multimap.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="empty()"><!-- --></A><H3>
+empty</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect">ImmutableMultimap</A><K,V>
<B>empty</B>()</PRE>
+<DL>
+<DD>Returns the empty multimap.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="builder()"><!-- --></A><H3>
+builder</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect">ImmutableMultimap.Builder</A><K,V>
<B>builder</B>()</PRE>
+<DL>
+<DD>Returns a new builder. The generated builder is equivalent to the
builder
+ created by the <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in
com.google.common.collect"><CODE>ImmutableMultimap.Builder</CODE></A>
constructor.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="copyOf(com.google.common.collect.Multimap)"><!-- --></A><H3>
+copyOf</H3>
+<PRE>
+public static <K,V> <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="class in com.google.common.collect">ImmutableMultimap</A><K,V>
<B>copyOf</B>(<A HREF="../../../../com/google/common/collect/Multimap.html"
title="interface in com.google.common.collect">Multimap</A><? extends
K,? extends V> multimap)</PRE>
+<DL>
+<DD>Returns an immutable multimap containing the same mappings as
+ <code>multimap</code>. The generated multimap's key and value orderings
+ correspond to the iteration ordering of the <code>multimap.asMap()</code>
view.
+
+ <p><b>Note:</b> Despite what the method name suggests, if
+ <code>multimap</code> is an <code>ImmutableMultimap</code>, no copy will
actually be
+ performed, and the given map itself will be returned.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true"
title="class or interface in java.lang">NullPointerException</A></CODE> -
if any key or value in <code>multimap</code> is
+ null</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeAll(java.lang.Object)"><!-- --></A><H3>
+removeAll</H3>
+<PRE>
+public <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> <B>removeAll</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#removeAll(java.lang.Object)">removeAll</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)">removeAll</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from
the multimap
+<DT><B>Returns:</B><DD>the collection of removed values, or an empty
collection if no
+ values were associated with the provided key. The collection
+ <i>may</i> be modifiable, but updating it will have no effect on the
+ multimap.
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!--
--></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3>
+replaceValues</H3>
+<PRE>
+public <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util">List</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>>
<B>replaceValues</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> values)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#replaceValues(K,
java.lang.Iterable)">replaceValues</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K,
java.lang.Iterable)">replaceValues</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the
multimap<DD><CODE>values</CODE> - values to store in the multimap
+<DT><B>Returns:</B><DD>the collection of replaced values, or an empty
collection if no
+ values were previously associated with the key. The collection
+ <i>may</i> be modifiable, but updating it will have no effect on the
+ multimap.
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="clear()"><!-- --></A><H3>
+clear</H3>
+<PRE>
+public void <B>clear</B>()</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A
NAME="put(K, V)"><!-- --></A><H3>
+put</H3>
+<PRE>
+public boolean <B>put</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A> value)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#put(K,
V)">put</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the
multimap<DD><CODE>value</CODE> - value to store in the multimap
+<DT><B>Returns:</B><DD><code>true</code> if the method increased the size
of the multimap, or
+ <code>false</code> if the multimap already contained the key-value
pair and
+ doesn't allow duplicates
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A
NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3>
+putAll</H3>
+<PRE>
+public boolean <B>putAll</B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> values)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#putAll(K,
java.lang.Iterable)">putAll</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the
multimap<DD><CODE>values</CODE> - values to store in the multimap
+<DT><B>Returns:</B><DD><code>true</code> if the multimap changed
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3>
+putAll</H3>
+<PRE>
+public boolean <B>putAll</B>(<A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,? extends <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> multimap)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in
this multimap
+<DT><B>Returns:</B><DD><code>true</code> if the multimap changed
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
+remove</H3>
+<PRE>
+public boolean <B>remove</B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key,
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</PRE>
+<DL>
+<DD>Guaranteed to throw an exception and leave the multimap unmodified.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object,
java.lang.Object)">remove</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entry to remove from
the multimap<DD><CODE>value</CODE> - value of entry to remove the multimap
+<DT><B>Returns:</B><DD><code>true</code> if the multimap changed
+<DT><B>Throws:</B>
+<DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"
title="class or interface in
java.lang">UnsupportedOperationException</A></CODE> - always</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!--
--></A><H3>
+containsEntry</H3>
+<PRE>
+public boolean <B>containsEntry</B>(<FONT SIZE="-1"><A
HREF="../../../../com/google/common/base/Nullable.html" title="annotation
in com.google.common.base">@Nullable</A></FONT>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key,
+ <FONT SIZE="-1"><A
HREF="../../../../com/google/common/base/Nullable.html" title="annotation
in com.google.common.base">@Nullable</A></FONT>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object,
java.lang.Object)">Multimap</A></CODE></B></DD>
+<DD>Returns <code>true</code> if the multimap contains the specified
key-value pair.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object,
java.lang.Object)">containsEntry</A></CODE> in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in
multimap<DD><CODE>value</CODE> - value to search for in multimap</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
+containsKey</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> key)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">Multimap</A></CODE></B></DD>
+<DD>Returns <code>true</code> if the multimap contains any values for the
specified
+ key.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in
multimap</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
+containsValue</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> value)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">Multimap</A></CODE></B></DD>
+<DD>Returns <code>true</code> if the multimap contains the specified value
for any
+ key.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in
multimap</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isEmpty()"><!-- --></A><H3>
+isEmpty</H3>
+<PRE>
+public boolean <B>isEmpty</B>()</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">Multimap</A></CODE></B></DD>
+<DD>Returns <code>true</code> if the multimap contains no key-value pairs.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="size()"><!-- --></A><H3>
+size</H3>
+<PRE>
+public int <B>size</B>()</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#size()">Multimap</A></CODE></B></DD>
+<DD>Returns the number of key-value pairs in the multimap.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
+<PRE>
+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>
+ <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> obj)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#equals(java.lang.Object)">ListMultimap</A></CODE></B></DD>
+<DD>Compares the specified object to this multimap for equality.
+
+ <p>Two <code>ListMultimap</code> instances are equal if, for each key,
they
+ contain the same values in the same order. If the value orderings
disagree,
+ the multimaps will not be considered equal.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#equals(java.lang.Object)">equals</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#equals(java.lang.Object)">equals</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</A></CODE> in class <CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</H3>
+<PRE>
+public int <B>hashCode</B>()</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">Multimap</A></CODE></B></DD>
+<DD>Returns the hash code for this multimap.
+
+ <p>The hash code of a multimap is defined as the hash code of the map
view,
+ as returned by <A
HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</A></CODE> in class
<CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</A></CODE> in class
<CODE><A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!--
--></A><H3>
+get</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableList.html"
title="class in com.google.common.collect">ImmutableList</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">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>
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A> key)</PRE>
+<DL>
+<DD>Returns an immutable list of the values for the given key. If no
mappings
+ in the multimap have the provided key, an empty immutable list is
returned.
+ The values are in the same order as the parameters used to build this
+ multimap.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#get(K)">get</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#get(K)">get</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap
+<DT><B>Returns:</B><DD>the collection of values that the key maps to</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="keySet()"><!-- --></A><H3>
+keySet</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableSet.html"
title="class in com.google.common.collect">ImmutableSet</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>> <B>keySet</B>()</PRE>
+<DL>
+<DD>Returns an immutable set of the distinct keys in this multimap. These
keys
+ are ordered according to when they first appeared during the construction
+ of this multimap.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the collection of distinct keys</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="asMap()"><!-- --></A><H3>
+asMap</H3>
+<PRE>
+public <A HREF="../../../../com/google/common/collect/ImmutableMap.html"
title="class in com.google.common.collect">ImmutableMap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util">Collection</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>>>
<B>asMap</B>()</PRE>
+<DL>
+<DD>Returns an immutable map that associates each key with its
corresponding
+ values in the multimap. Though the method signature doesn't say so
+ explicitly, the returned map has <A
HREF="../../../../com/google/common/collect/ImmutableList.html"
title="class in com.google.common.collect"><CODE>ImmutableList</CODE></A>
values.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html#asMap()">asMap</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/ListMultimap.html"
title="interface in com.google.common.collect">ListMultimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in
ImmutableMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#asMap()">asMap</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a map view from a key to its collection of
values</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="entries()"><!-- --></A><H3>
+entries</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect">ImmutableCollection</A><<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true"
title="class or interface in java.util">Map.Entry</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>>>
<B>entries</B>()</PRE>
+<DL>
+<DD>Returns an immutable collection of all key-value pairs in the
multimap. Its
+ iterator traverses the values for the first key, the values for the second
+ key, and so on.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#entries()">entries</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>collection of map entries consisting of key-value
pairs</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="keys()"><!-- --></A><H3>
+keys</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in com.google.common.collect">ImmutableMultiset</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>> <B>keys</B>()</PRE>
+<DL>
+<DD>Returns a collection, which may contain duplicates, of all keys. The
number
+ of times of key appears in the returned multiset equals the number of
+ mappings the key has in the multimap. Duplicate keys appear consecutively
+ in the multiset's iteration order.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct
keys of the
+ multimap and frequencies corresponding to the number of values that
+ each key maps to</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="values()"><!-- --></A><H3>
+values</H3>
+<PRE>
+public <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in com.google.common.collect">ImmutableCollection</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>> <B>values</B>()</PRE>
+<DL>
+<DD>Returns an immutable collection of the values in this multimap. Its
+ iterator traverses the values for the first key, the values for the second
+ key, and so on.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A
HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></CODE>
in interface <CODE><A
HREF="../../../../com/google/common/collect/Multimap.html" title="interface
in com.google.common.collect">Multimap</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">K</A>,<A
HREF="../../../../com/google/common/collect/ImmutableMultimap.html"
title="type parameter in ImmutableMultimap">V</A>></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>collection of values, which may include the same
value multiple
+ times if it occurs in multiple mappings</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableMultimap.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableMultimap.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> |
FIELD | CONSTR | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Added: trunk/javadoc/com/google/common/collect/ImmutableMultiset.html
==============================================================================
--- (empty file)
+++ trunk/javadoc/com/google/common/collect/ImmutableMultiset.html Mon Aug
18 17:20:45 2008
@@ -0,0 +1,786 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_01) on Mon Aug 18 15:24:23
GMT-08:00 2008 -->
+<TITLE>
+ImmutableMultiset (Google Collections Library - snapshot-20080818 (ALPHA))
+</TITLE>
+
+<META NAME="date" CONTENT="2008-08-18">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css"
TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ImmutableMultiset (Google Collections
Library - snapshot-20080818 (ALPHA))";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../overview-summary.html"><FONT
CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-summary.html"><FONT
CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT
CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="package-tree.html"><FONT
CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../deprecated-list.html"><FONT
CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../index-all.html"><FONT
CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A
HREF="../../../../help-doc.html"><FONT
CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html"
title="class in com.google.common.collect"><B>PREV CLASS</B></A>
+ <A HREF="../../../../com/google/common/collect/ImmutableSet.html"
title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A
HREF="../../../../index.html?com/google/common/collect/ImmutableMultiset.html"
target="_top"><B>FRAMES</B></A>
+ <A HREF="ImmutableMultiset.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All
Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A
HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A
HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.google.common.collect</FONT>
+<BR>
+Class ImmutableMultiset<E></H2>
+<PRE>
+<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in
com.google.common.collect">com.google.common.collect.ImmutableCollection</A><E>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended
by "><B>com.google.common.collect.ImmutableMultiset<E></B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A
HREF="../../../../com/google/common/collect/Multiset.html" title="interface
in com.google.common.collect">Multiset</A><E>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"
title="class or interface in java.io">Serializable</A>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><E>, <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true"
title="class or interface in java.util">Collection</A><E></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>ImmutableMultiset<E></B><DT>extends <A
HREF="../../../../com/google/common/collect/ImmutableCollection.html"
title="class in
com.google.common.collect">ImmutableCollection</A><E><DT>implements
<A HREF="../../../../com/google/common/collect/Multiset.html"
title="interface in com.google.common.collect">Multiset</A><E></DL>
+</PRE>
+
+<P>
+An immutable hash-based multiset. Does not permit null elements.
+
+ <p>Its iterator orders elements according to the first appearance of the
+ element among the items passed to the factory method. When the multiset
+ contains multiple instances of an element, those instances are
consecutive in
+ the iteration order.
+<P>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>Jared Levy</DD>
+<DT><B>See Also:</B><DD><A
HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableMultiset">Serialized
Form</A></DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+<A NAME="nested_class_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
+</TR>
+</TABLE>
+ <A
NAME="nested_classes_inherited_from_class_com.google.common.collect.Multiset"><!--
--></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface
com.google.common.collect.<A
HREF="../../../../com/google/common/collect/Multiset.html" title="interface
in com.google.common.collect">Multiset</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A
HREF="../../../../com/google/common/collect/Multiset.Entry.html"
title="interface in com.google.common.collect">Multiset.Entry</A><<A
HREF="../../../../com/google/common/collect/Multiset.Entry.html"
title="type parameter in Multiset.Entry">E</A>></CODE></TD>
+</TR>
+</TABLE>
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#add(E,
int)">add</A></B>(<A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="type parameter in ImmutableMultiset">E</A> element,
+ int occurrences)</CODE>
+
+<BR>
+ Guaranteed to
throw an exception and leave the collection unmodified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#contains(java.lang.Object)">contains</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> element)</CODE>
+
+<BR>
+ Determines
whether this multiset contains the specified element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><E> <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in
com.google.common.collect">ImmutableMultiset</A><E></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#copyOf(java.lang.Iterable)">copyOf</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"
title="class or interface in java.lang">Iterable</A><? extends
E> elements)</CODE>
+
+<BR>
+ Returns an
immutable multiset containing the given elements.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><E> <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in
com.google.common.collect">ImmutableMultiset</A><E></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#copyOf(java.util.Iterator)">copyOf</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"
title="class or interface in java.util">Iterator</A><? extends
E> elements)</CODE>
+
+<BR>
+ Returns an
immutable multiset containing the given elements.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#count(java.lang.Object)">count</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> element)</CODE>
+
+<BR>
+ Returns the
number of occurrences of an element in this multiset (the
+ <i>count</i> of the element).</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true"
title="class or interface in java.util">Set</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="type parameter in ImmutableMultiset">E</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#elementSet()">elementSet</A></B>()</CODE>
+
+<BR>
+ Returns the
set of distinct elements contained in this multiset.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true"
title="class or interface in java.util">Set</A><<A
HREF="../../../../com/google/common/collect/Multiset.Entry.html"
title="interface in com.google.common.collect">Multiset.Entry</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="type parameter in ImmutableMultiset">E</A>>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#entrySet()">entrySet</A></B>()</CODE>
+
+<BR>
+ Returns a view
of the contents of this multiset, grouped into <code>Multiset.Entry</code>
instances, each providing an element of the multiset and
+ the count of that element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#equals(java.lang.Object)">equals</A></B>(<A
HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</A> other)</CODE>
+
+<BR>
+ Compares the
specified object with this multiset for equality.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+ Returns the
hash code for this multiset.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A
HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"
title="class or interface in java.util">Iterator</A><<A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="type parameter in ImmutableMultiset">E</A>></CODE></FONT></TD>
+<TD><CODE><B><A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html#iterator()">iterator</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><E> <A
HREF="../../../../com/google/common/collect/ImmutableMultiset.html"
title="class in
com.google.common.collect">ImmutableMultiset</A><E></CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../com/google/common/colle
==============================================================================
Diff truncated at 200k characters