1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2 <!--NewPage--> 3 <HTML> 4 <HEAD> 5 <!-- Generated by javadoc (build 1.6.0-google-internal) on Mon Jan 04 20:47:56 PST 2010 --> 6 <TITLE> 7 Joiner.MapJoiner (Guava Libraries 2010.01.04) 8 </TITLE> 9 10 <META NAME="date" CONTENT="2010-01-04"> 11 12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 13 14 <SCRIPT type="text/javascript"> 15 function windowTitle() 16 { 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="Joiner.MapJoiner (Guava Libraries 2010.01.04)"; 19 } 20 } 21 </SCRIPT> 22 <NOSCRIPT> 23 </NOSCRIPT> 24 25 </HEAD> 26 27 <BODY BGCOLOR="white" onload="windowTitle();"> 28 <HR> 29 30 31 <!-- ========= START OF TOP NAVBAR ======= --> 32 <A NAME="navbar_top"><!-- --></A> 33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35 <TR> 36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37 <A NAME="navbar_top_firstrow"><!-- --></A> 38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Joiner.MapJoiner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49 </TABLE> 50 </TD> 51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52 </EM> 53 </TD> 54 </TR> 55 56 <TR> 57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/google/common/base/Joiner.html" title="class in com.google.common.base"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/base/Objects.html" title="class in com.google.common.base"><B>NEXT CLASS</B></A></FONT></TD> 60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/google/common/base/Joiner.MapJoiner.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="Joiner.MapJoiner.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69 </SCRIPT> 70 <NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72 </NOSCRIPT> 73 74 75 </FONT></TD> 76 </TR> 77 <TR> 78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 82 </TR> 83 </TABLE> 84 <A NAME="skip-navbar_top"></A> 85 <!-- ========= END OF TOP NAVBAR ========= --> 86 87 <HR> 88 <!-- ======== START OF CLASS DATA ======== --> 89 <H2> 90 <FONT SIZE="-1"> 91 com.google.common.base</FONT> 92 <BR> 93 Class Joiner.MapJoiner</H2> 94 <PRE> 95 <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> 96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.base.Joiner.MapJoiner</B> 97 </PRE> 98 <DL> 99 <DT><B>Enclosing class:</B><DD><A HREF="../../../../com/google/common/base/Joiner.html" title="class in com.google.common.base">Joiner</A></DD> 100 </DL> 101 <HR> 102 <DL> 103 <DT><PRE>public static class <B>Joiner.MapJoiner</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> 104 </PRE> 105 106 <P> 107 An object that joins map entries in the same manner as <code>Joiner</code> joins 108 iterables and arrays. 109 <P> 110 111 <P> 112 <HR> 113 114 <P> 115 116 <!-- ========== METHOD SUMMARY =========== --> 117 118 <A NAME="method_summary"><!-- --></A> 119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 122 <B>Method Summary</B></FONT></TH> 123 </TR> 124 <TR BGCOLOR="white" CLASS="TableRowColor"> 125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 126 <CODE> 127 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 128 <TR ALIGN="right" VALIGN=""> 129 <TD NOWRAP><FONT SIZE="-1"> 130 <CODE><A extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A>> 131 <BR> 132 A</CODE></FONT></TD> 133 </TR> 134 </TABLE> 135 </CODE></FONT></TD> 136 <TD><CODE><B><A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html#appendTo(A, java.util.Map)">appendTo</A></B>(A appendable, 137 <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><?,?> map)</CODE> 138 139 <BR> 140 Appends the string representation of each entry of <code>map</code>, using the 141 previously configured separator and key-value separator, to <code>appendable</code>.</TD> 142 </TR> 143 <TR BGCOLOR="white" CLASS="TableRowColor"> 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A></CODE></FONT></TD> 146 <TD><CODE><B><A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html#appendTo(java.lang.StringBuilder, java.util.Map)">appendTo</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> builder, 147 <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><?,?> map)</CODE> 148 149 <BR> 150 Appends the string representation of each entry of <code>map</code>, using the 151 previously configured separator and key-value separator, to <code>builder</code>.</TD> 152 </TR> 153 <TR BGCOLOR="white" CLASS="TableRowColor"> 154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 155 <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> 156 <TD><CODE><B><A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html#join(java.util.Map)">join</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><?,?> map)</CODE> 157 158 <BR> 159 Returns a string containing the string representation of each entry of 160 <code>map</code>, using the previously configured separator and key-value 161 separator.</TD> 162 </TR> 163 <TR BGCOLOR="white" CLASS="TableRowColor"> 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165 <CODE> <A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html" title="class in com.google.common.base">Joiner.MapJoiner</A></CODE></FONT></TD> 166 <TD><CODE><B><A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html#useForNull(java.lang.String)">useForNull</A></B>(<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> nullText)</CODE> 167 168 <BR> 169 Returns a map joiner with the same behavior as this one, except 170 automatically substituting <code>nullText</code> for any provided null keys or 171 values.</TD> 172 </TR> 173 </TABLE> 174 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 176 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 177 <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> 178 </TR> 179 <TR BGCOLOR="white" CLASS="TableRowColor"> 180 <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> 181 </TR> 182 </TABLE> 183 184 <P> 185 186 <!-- ============ METHOD DETAIL ========== --> 187 188 <A NAME="method_detail"><!-- --></A> 189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 191 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 192 <B>Method Detail</B></FONT></TH> 193 </TR> 194 </TABLE> 195 196 <A NAME="appendTo(java.lang.Appendable,java.util.Map)"><!-- --></A><A NAME="appendTo(A, java.util.Map)"><!-- --></A><H3> 197 appendTo</H3> 198 <PRE> 199 public <A extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A>> A <B>appendTo</B>(A appendable, 200 <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><?,?> map) 201 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> 202 <DL> 203 <DD>Appends the string representation of each entry of <code>map</code>, using the 204 previously configured separator and key-value separator, to <code>appendable</code>. 205 <P> 206 <DD><DL> 207 208 <DT><B>Throws:</B> 209 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> 210 </DD> 211 </DL> 212 <HR> 213 214 <A NAME="appendTo(java.lang.StringBuilder, java.util.Map)"><!-- --></A><H3> 215 appendTo</H3> 216 <PRE> 217 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> <B>appendTo</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> builder, 218 <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><?,?> map)</PRE> 219 <DL> 220 <DD>Appends the string representation of each entry of <code>map</code>, using the 221 previously configured separator and key-value separator, to <code>builder</code>. Identical to <A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html#appendTo(A, java.util.Map)"><CODE>appendTo(Appendable, Map)</CODE></A>, except that it 222 does not throw <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><CODE>IOException</CODE></A>. 223 <P> 224 <DD><DL> 225 </DL> 226 </DD> 227 </DL> 228 <HR> 229 230 <A NAME="join(java.util.Map)"><!-- --></A><H3> 231 join</H3> 232 <PRE> 233 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>join</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><?,?> map)</PRE> 234 <DL> 235 <DD>Returns a string containing the string representation of each entry of 236 <code>map</code>, using the previously configured separator and key-value 237 separator. 238 <P> 239 <DD><DL> 240 </DL> 241 </DD> 242 </DL> 243 <HR> 244 245 <A NAME="useForNull(java.lang.String)"><!-- --></A><H3> 246 useForNull</H3> 247 <PRE> 248 public <A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html" title="class in com.google.common.base">Joiner.MapJoiner</A> <B>useForNull</B>(<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> nullText)</PRE> 249 <DL> 250 <DD>Returns a map joiner with the same behavior as this one, except 251 automatically substituting <code>nullText</code> for any provided null keys or 252 values. 253 <P> 254 <DD><DL> 255 </DL> 256 </DD> 257 </DL> 258 <!-- ========= END OF CLASS DATA ========= --> 259 <HR> 260 261 262 <!-- ======= START OF BOTTOM NAVBAR ====== --> 263 <A NAME="navbar_bottom"><!-- --></A> 264 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 265 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 266 <TR> 267 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 268 <A NAME="navbar_bottom_firstrow"><!-- --></A> 269 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 270 <TR ALIGN="center" VALIGN="top"> 271 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 272 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 273 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 274 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Joiner.MapJoiner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 275 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 276 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 277 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 279 </TR> 280 </TABLE> 281 </TD> 282 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 283 </EM> 284 </TD> 285 </TR> 286 287 <TR> 288 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 289 <A HREF="../../../../com/google/common/base/Joiner.html" title="class in com.google.common.base"><B>PREV CLASS</B></A> 290 <A HREF="../../../../com/google/common/base/Objects.html" title="class in com.google.common.base"><B>NEXT CLASS</B></A></FONT></TD> 291 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 292 <A HREF="../../../../index.html?com/google/common/base/Joiner.MapJoiner.html" target="_top"><B>FRAMES</B></A> 293 <A HREF="Joiner.MapJoiner.html" target="_top"><B>NO FRAMES</B></A> 294 <SCRIPT type="text/javascript"> 295 <!-- 296 if(window==top) { 297 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 298 } 299 //--> 300 </SCRIPT> 301 <NOSCRIPT> 302 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 303 </NOSCRIPT> 304 305 306 </FONT></TD> 307 </TR> 308 <TR> 309 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 310 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 311 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 312 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 313 </TR> 314 </TABLE> 315 <A NAME="skip-navbar_bottom"></A> 316 <!-- ======== END OF BOTTOM NAVBAR ======= --> 317 318 <HR> 319 320 </BODY> 321 </HTML> 322
