KezvhLib/lib/org.apache.commons.collections/apidocs/org/apache/commons/collections/collection/SynchronizedCollection.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_07) on Fri Apr 11 15:39:19 BST 2008 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 SynchronizedCollection (Commons Collections 3.2.1 API)
   9 </TITLE>
  10
  11 <META NAME="keywords" CONTENT="org.apache.commons.collections.collection.SynchronizedCollection class">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     parent.document.title="SynchronizedCollection (Commons Collections 3.2.1 API)";
  19 }
  20 </SCRIPT>
  21 <NOSCRIPT>
  22 </NOSCRIPT>
  23
  24 </HEAD>
  25
  26 <BODY BGCOLOR="white" onload="windowTitle();">
  27
  28
  29 <!-- ========= START OF TOP NAVBAR ======= -->
  30 <A NAME="navbar_top"><!-- --></A>
  31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  33 <TR>
  34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  35 <A NAME="navbar_top_firstrow"><!-- --></A>
  36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  37   <TR ALIGN="center" VALIGN="top">
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SynchronizedCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  46   </TR>
  47 </TABLE>
  48 </TD>
  49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50 </EM>
  51 </TD>
  52 </TR>
  53
  54 <TR>
  55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56 &nbsp;<A HREF="../../../../../org/apache/commons/collections/collection/PredicatedCollection.html" title="class in org.apache.commons.collections.collection"><B>PREV CLASS</B></A>&nbsp;
  57 &nbsp;<A HREF="../../../../../org/apache/commons/collections/collection/TransformedCollection.html" title="class in org.apache.commons.collections.collection"><B>NEXT CLASS</B></A></FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../../../index.html?org/apache/commons/collections/collection/SynchronizedCollection.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="SynchronizedCollection.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61 &nbsp;<SCRIPT type="text/javascript">
  62   <!--
  63   if(window==top) {
  64     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  65   }
  66   //-->
  67 </SCRIPT>
  68 <NOSCRIPT>
  69   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  70 </NOSCRIPT>
  71
  72
  73 </FONT></TD>
  74 </TR>
  75 <TR>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  80 </TR>
  81 </TABLE>
  82 <A NAME="skip-navbar_top"></A>
  83 <!-- ========= END OF TOP NAVBAR ========= -->
  84
  85 <HR>
  86 <!-- ======== START OF CLASS DATA ======== -->
  87 <H2>
  88 <FONT SIZE="-1">
  89 org.apache.commons.collections.collection</FONT>
  90 <BR>
  91 Class SynchronizedCollection</H2>
  92 <PRE>
  93 java.lang.Object
  94   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.collections.collection.SynchronizedCollection</B>
  95 </PRE>
  96 <DL>
  97 <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Iterable, java.util.Collection</DD>
  98 </DL>
  99 <DL>
 100 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/commons/collections/bag/SynchronizedBag.html" title="class in org.apache.commons.collections.bag">SynchronizedBag</A>, <A HREF="../../../../../org/apache/commons/collections/buffer/SynchronizedBuffer.html" title="class in org.apache.commons.collections.buffer">SynchronizedBuffer</A>, <A HREF="../../../../../org/apache/commons/collections/list/SynchronizedList.html" title="class in org.apache.commons.collections.list">SynchronizedList</A>, <A HREF="../../../../../org/apache/commons/collections/set/SynchronizedSet.html" title="class in org.apache.commons.collections.set">SynchronizedSet</A>, <A HREF="../../../../../org/apache/commons/collections/set/SynchronizedSortedSet.html" title="class in org.apache.commons.collections.set">SynchronizedSortedSet</A></DD>
 101 </DL>
 102 <HR>
 103 <DL>
 104 <DT><PRE>public class <B>SynchronizedCollection</B><DT>extends java.lang.Object<DT>implements java.util.Collection, java.io.Serializable</DL>
 105 </PRE>
 106
 107 <P>
 108 Decorates another <code>Collection</code> to synchronize its behaviour
 109  for a multi-threaded environment.
 110  <p>
 111  Iterators must be manually synchronized:
 112  <pre>
 113  synchronized (coll) {
 114    Iterator it = coll.iterator();
 115    // do stuff with iterator
 116  }
 117  </pre>
 118  <p>
 119  This class is Serializable from Commons Collections 3.1.
 120 <P>
 121
 122 <P>
 123 <DL>
 124 <DT><B>Since:</B></DT>
 125   <DD>Commons Collections 3.0</DD>
 126 <DT><B>Version:</B></DT>
 127   <DD>$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $</DD>
 128 <DT><B>Author:</B></DT>
 129   <DD>Stephen Colebourne</DD>
 130 <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.commons.collections.collection.SynchronizedCollection">Serialized Form</A></DL>
 131 <HR>
 132
 133 <P>
 134 <!-- =========== FIELD SUMMARY =========== -->
 135
 136 <A NAME="field_summary"><!-- --></A>
 137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 139 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 140 <B>Field Summary</B></FONT></TH>
 141 </TR>
 142 <TR BGCOLOR="white" CLASS="TableRowColor">
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 144 <CODE>protected &nbsp;java.util.Collection</CODE></FONT></TD>
 145 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#collection">collection</A></B></CODE>
 146
 147 <BR>
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The collection to decorate</TD>
 149 </TR>
 150 <TR BGCOLOR="white" CLASS="TableRowColor">
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 152 <CODE>protected &nbsp;java.lang.Object</CODE></FONT></TD>
 153 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#lock">lock</A></B></CODE>
 154
 155 <BR>
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The object to lock on, needed for List/SortedSet views</TD>
 157 </TR>
 158 </TABLE>
 159 &nbsp;
 160 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 161
 162 <A NAME="constructor_summary"><!-- --></A>
 163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 165 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 166 <B>Constructor Summary</B></FONT></TH>
 167 </TR>
 168 <TR BGCOLOR="white" CLASS="TableRowColor">
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 170 <CODE>protected </CODE></FONT></TD>
 171 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#SynchronizedCollection(java.util.Collection)">SynchronizedCollection</A></B>(java.util.Collection&nbsp;collection)</CODE>
 172
 173 <BR>
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that wraps (not copies).</TD>
 175 </TR>
 176 <TR BGCOLOR="white" CLASS="TableRowColor">
 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 178 <CODE>protected </CODE></FONT></TD>
 179 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#SynchronizedCollection(java.util.Collection, java.lang.Object)">SynchronizedCollection</A></B>(java.util.Collection&nbsp;collection,
 180                        java.lang.Object&nbsp;lock)</CODE>
 181
 182 <BR>
 183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that wraps (not copies).</TD>
 184 </TR>
 185 </TABLE>
 186 &nbsp;
 187 <!-- ========== METHOD SUMMARY =========== -->
 188
 189 <A NAME="method_summary"><!-- --></A>
 190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 192 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 193 <B>Method Summary</B></FONT></TH>
 194 </TR>
 195 <TR BGCOLOR="white" CLASS="TableRowColor">
 196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 197 <CODE>&nbsp;boolean</CODE></FONT></TD>
 198 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#add(java.lang.Object)">add</A></B>(java.lang.Object&nbsp;object)</CODE>
 199
 200 <BR>
 201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 202 </TR>
 203 <TR BGCOLOR="white" CLASS="TableRowColor">
 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 205 <CODE>&nbsp;boolean</CODE></FONT></TD>
 206 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#addAll(java.util.Collection)">addAll</A></B>(java.util.Collection&nbsp;coll)</CODE>
 207
 208 <BR>
 209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 210 </TR>
 211 <TR BGCOLOR="white" CLASS="TableRowColor">
 212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 213 <CODE>&nbsp;void</CODE></FONT></TD>
 214 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#clear()">clear</A></B>()</CODE>
 215
 216 <BR>
 217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 218 </TR>
 219 <TR BGCOLOR="white" CLASS="TableRowColor">
 220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 221 <CODE>&nbsp;boolean</CODE></FONT></TD>
 222 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#contains(java.lang.Object)">contains</A></B>(java.lang.Object&nbsp;object)</CODE>
 223
 224 <BR>
 225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 226 </TR>
 227 <TR BGCOLOR="white" CLASS="TableRowColor">
 228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 229 <CODE>&nbsp;boolean</CODE></FONT></TD>
 230 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#containsAll(java.util.Collection)">containsAll</A></B>(java.util.Collection&nbsp;coll)</CODE>
 231
 232 <BR>
 233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 234 </TR>
 235 <TR BGCOLOR="white" CLASS="TableRowColor">
 236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 237 <CODE>static&nbsp;java.util.Collection</CODE></FONT></TD>
 238 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#decorate(java.util.Collection)">decorate</A></B>(java.util.Collection&nbsp;coll)</CODE>
 239
 240 <BR>
 241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory method to create a synchronized collection.</TD>
 242 </TR>
 243 <TR BGCOLOR="white" CLASS="TableRowColor">
 244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 245 <CODE>&nbsp;boolean</CODE></FONT></TD>
 246 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;object)</CODE>
 247
 248 <BR>
 249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 250 </TR>
 251 <TR BGCOLOR="white" CLASS="TableRowColor">
 252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 253 <CODE>&nbsp;int</CODE></FONT></TD>
 254 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#hashCode()">hashCode</A></B>()</CODE>
 255
 256 <BR>
 257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 258 </TR>
 259 <TR BGCOLOR="white" CLASS="TableRowColor">
 260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 261 <CODE>&nbsp;boolean</CODE></FONT></TD>
 262 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#isEmpty()">isEmpty</A></B>()</CODE>
 263
 264 <BR>
 265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 266 </TR>
 267 <TR BGCOLOR="white" CLASS="TableRowColor">
 268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 269 <CODE>&nbsp;java.util.Iterator</CODE></FONT></TD>
 270 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#iterator()">iterator</A></B>()</CODE>
 271
 272 <BR>
 273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Iterators must be manually synchronized.</TD>
 274 </TR>
 275 <TR BGCOLOR="white" CLASS="TableRowColor">
 276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 277 <CODE>&nbsp;boolean</CODE></FONT></TD>
 278 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object&nbsp;object)</CODE>
 279
 280 <BR>
 281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 282 </TR>
 283 <TR BGCOLOR="white" CLASS="TableRowColor">
 284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 285 <CODE>&nbsp;boolean</CODE></FONT></TD>
 286 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#removeAll(java.util.Collection)">removeAll</A></B>(java.util.Collection&nbsp;coll)</CODE>
 287
 288 <BR>
 289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 290 </TR>
 291 <TR BGCOLOR="white" CLASS="TableRowColor">
 292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 293 <CODE>&nbsp;boolean</CODE></FONT></TD>
 294 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#retainAll(java.util.Collection)">retainAll</A></B>(java.util.Collection&nbsp;coll)</CODE>
 295
 296 <BR>
 297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 298 </TR>
 299 <TR BGCOLOR="white" CLASS="TableRowColor">
 300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 301 <CODE>&nbsp;int</CODE></FONT></TD>
 302 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#size()">size</A></B>()</CODE>
 303
 304 <BR>
 305 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 306 </TR>
 307 <TR BGCOLOR="white" CLASS="TableRowColor">
 308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 309 <CODE>&nbsp;java.lang.Object[]</CODE></FONT></TD>
 310 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#toArray()">toArray</A></B>()</CODE>
 311
 312 <BR>
 313 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 314 </TR>
 315 <TR BGCOLOR="white" CLASS="TableRowColor">
 316 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 317 <CODE>&nbsp;java.lang.Object[]</CODE></FONT></TD>
 318 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#toArray(java.lang.Object[])">toArray</A></B>(java.lang.Object[]&nbsp;object)</CODE>
 319
 320 <BR>
 321 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 322 </TR>
 323 <TR BGCOLOR="white" CLASS="TableRowColor">
 324 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 325 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 326 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/collection/SynchronizedCollection.html#toString()">toString</A></B>()</CODE>
 327
 328 <BR>
 329 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 330 </TR>
 331 </TABLE>
 332 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 333 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 334 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 335 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 336 </TR>
 337 <TR BGCOLOR="white" CLASS="TableRowColor">
 338 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
 339 </TR>
 340 </TABLE>
 341 &nbsp;
 342 <P>
 343
 344 <!-- ============ FIELD DETAIL =========== -->
 345
 346 <A NAME="field_detail"><!-- --></A>
 347 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 348 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 349 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 350 <B>Field Detail</B></FONT></TH>
 351 </TR>
 352 </TABLE>
 353
 354 <A NAME="collection"><!-- --></A><H3>
 355 collection</H3>
 356 <PRE>
 357 protected final java.util.Collection <B>collection</B></PRE>
 358 <DL>
 359 <DD>The collection to decorate
 360 <P>
 361 <DL>
 362 </DL>
 363 </DL>
 364 <HR>
 365
 366 <A NAME="lock"><!-- --></A><H3>
 367 lock</H3>
 368 <PRE>
 369 protected final java.lang.Object <B>lock</B></PRE>
 370 <DL>
 371 <DD>The object to lock on, needed for List/SortedSet views
 372 <P>
 373 <DL>
 374 </DL>
 375 </DL>
 376
 377 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 378
 379 <A NAME="constructor_detail"><!-- --></A>
 380 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 381 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 382 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 383 <B>Constructor Detail</B></FONT></TH>
 384 </TR>
 385 </TABLE>
 386
 387 <A NAME="SynchronizedCollection(java.util.Collection)"><!-- --></A><H3>
 388 SynchronizedCollection</H3>
 389 <PRE>
 390 protected <B>SynchronizedCollection</B>(java.util.Collection&nbsp;collection)</PRE>
 391 <DL>
 392 <DD>Constructor that wraps (not copies).
 393 <P>
 394 <DL>
 395 <DT><B>Parameters:</B><DD><CODE>collection</CODE> - the collection to decorate, must not be null
 396 <DT><B>Throws:</B>
 397 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the collection is null</DL>
 398 </DL>
 399 <HR>
 400
 401 <A NAME="SynchronizedCollection(java.util.Collection, java.lang.Object)"><!-- --></A><H3>
 402 SynchronizedCollection</H3>
 403 <PRE>
 404 protected <B>SynchronizedCollection</B>(java.util.Collection&nbsp;collection,
 405                                  java.lang.Object&nbsp;lock)</PRE>
 406 <DL>
 407 <DD>Constructor that wraps (not copies).
 408 <P>
 409 <DL>
 410 <DT><B>Parameters:</B><DD><CODE>collection</CODE> - the collection to decorate, must not be null<DD><CODE>lock</CODE> - the lock object to use, must not be null
 411 <DT><B>Throws:</B>
 412 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the collection is null</DL>
 413 </DL>
 414
 415 <!-- ============ METHOD DETAIL ========== -->
 416
 417 <A NAME="method_detail"><!-- --></A>
 418 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 419 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 420 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 421 <B>Method Detail</B></FONT></TH>
 422 </TR>
 423 </TABLE>
 424
 425 <A NAME="decorate(java.util.Collection)"><!-- --></A><H3>
 426 decorate</H3>
 427 <PRE>
 428 public static java.util.Collection <B>decorate</B>(java.util.Collection&nbsp;coll)</PRE>
 429 <DL>
 430 <DD>Factory method to create a synchronized collection.
 431 <P>
 432 <DD><DL>
 433 </DL>
 434 </DD>
 435 <DD><DL>
 436 <DT><B>Parameters:</B><DD><CODE>coll</CODE> - the collection to decorate, must not be null
 437 <DT><B>Returns:</B><DD>a new synchronized collection
 438 <DT><B>Throws:</B>
 439 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if collection is null</DL>
 440 </DD>
 441 </DL>
 442 <HR>
 443
 444 <A NAME="add(java.lang.Object)"><!-- --></A><H3>
 445 add</H3>
 446 <PRE>
 447 public boolean <B>add</B>(java.lang.Object&nbsp;object)</PRE>
 448 <DL>
 449 <DD><DL>
 450 <DT><B>Specified by:</B><DD><CODE>add</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 451 </DD>
 452 <DD><DL>
 453 </DL>
 454 </DD>
 455 </DL>
 456 <HR>
 457
 458 <A NAME="addAll(java.util.Collection)"><!-- --></A><H3>
 459 addAll</H3>
 460 <PRE>
 461 public boolean <B>addAll</B>(java.util.Collection&nbsp;coll)</PRE>
 462 <DL>
 463 <DD><DL>
 464 <DT><B>Specified by:</B><DD><CODE>addAll</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 465 </DD>
 466 <DD><DL>
 467 </DL>
 468 </DD>
 469 </DL>
 470 <HR>
 471
 472 <A NAME="clear()"><!-- --></A><H3>
 473 clear</H3>
 474 <PRE>
 475 public void <B>clear</B>()</PRE>
 476 <DL>
 477 <DD><DL>
 478 <DT><B>Specified by:</B><DD><CODE>clear</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 479 </DD>
 480 <DD><DL>
 481 </DL>
 482 </DD>
 483 </DL>
 484 <HR>
 485
 486 <A NAME="contains(java.lang.Object)"><!-- --></A><H3>
 487 contains</H3>
 488 <PRE>
 489 public boolean <B>contains</B>(java.lang.Object&nbsp;object)</PRE>
 490 <DL>
 491 <DD><DL>
 492 <DT><B>Specified by:</B><DD><CODE>contains</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 493 </DD>
 494 <DD><DL>
 495 </DL>
 496 </DD>
 497 </DL>
 498 <HR>
 499
 500 <A NAME="containsAll(java.util.Collection)"><!-- --></A><H3>
 501 containsAll</H3>
 502 <PRE>
 503 public boolean <B>containsAll</B>(java.util.Collection&nbsp;coll)</PRE>
 504 <DL>
 505 <DD><DL>
 506 <DT><B>Specified by:</B><DD><CODE>containsAll</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 507 </DD>
 508 <DD><DL>
 509 </DL>
 510 </DD>
 511 </DL>
 512 <HR>
 513
 514 <A NAME="isEmpty()"><!-- --></A><H3>
 515 isEmpty</H3>
 516 <PRE>
 517 public boolean <B>isEmpty</B>()</PRE>
 518 <DL>
 519 <DD><DL>
 520 <DT><B>Specified by:</B><DD><CODE>isEmpty</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 521 </DD>
 522 <DD><DL>
 523 </DL>
 524 </DD>
 525 </DL>
 526 <HR>
 527
 528 <A NAME="iterator()"><!-- --></A><H3>
 529 iterator</H3>
 530 <PRE>
 531 public java.util.Iterator <B>iterator</B>()</PRE>
 532 <DL>
 533 <DD>Iterators must be manually synchronized.
 534  <pre>
 535  synchronized (coll) {
 536    Iterator it = coll.iterator();
 537    // do stuff with iterator
 538  }
 539 <P>
 540 <DD><DL>
 541 <DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.lang.Iterable</CODE><DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 542 </DD>
 543 <DD><DL>
 544
 545 <DT><B>Returns:</B><DD>an iterator that must be manually synchronized on the collection</DL>
 546 </DD>
 547 </DL>
 548 <HR>
 549
 550 <A NAME="toArray()"><!-- --></A><H3>
 551 toArray</H3>
 552 <PRE>
 553 public java.lang.Object[] <B>toArray</B>()</PRE>
 554 <DL>
 555 <DD><DL>
 556 <DT><B>Specified by:</B><DD><CODE>toArray</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 557 </DD>
 558 <DD><DL>
 559 </DL>
 560 </DD>
 561 </DL>
 562 <HR>
 563
 564 <A NAME="toArray(java.lang.Object[])"><!-- --></A><H3>
 565 toArray</H3>
 566 <PRE>
 567 public java.lang.Object[] <B>toArray</B>(java.lang.Object[]&nbsp;object)</PRE>
 568 <DL>
 569 <DD><DL>
 570 <DT><B>Specified by:</B><DD><CODE>toArray</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 571 </DD>
 572 <DD><DL>
 573 </DL>
 574 </DD>
 575 </DL>
 576 <HR>
 577
 578 <A NAME="remove(java.lang.Object)"><!-- --></A><H3>
 579 remove</H3>
 580 <PRE>
 581 public boolean <B>remove</B>(java.lang.Object&nbsp;object)</PRE>
 582 <DL>
 583 <DD><DL>
 584 <DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 585 </DD>
 586 <DD><DL>
 587 </DL>
 588 </DD>
 589 </DL>
 590 <HR>
 591
 592 <A NAME="removeAll(java.util.Collection)"><!-- --></A><H3>
 593 removeAll</H3>
 594 <PRE>
 595 public boolean <B>removeAll</B>(java.util.Collection&nbsp;coll)</PRE>
 596 <DL>
 597 <DD><DL>
 598 <DT><B>Specified by:</B><DD><CODE>removeAll</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 599 </DD>
 600 <DD><DL>
 601 </DL>
 602 </DD>
 603 </DL>
 604 <HR>
 605
 606 <A NAME="retainAll(java.util.Collection)"><!-- --></A><H3>
 607 retainAll</H3>
 608 <PRE>
 609 public boolean <B>retainAll</B>(java.util.Collection&nbsp;coll)</PRE>
 610 <DL>
 611 <DD><DL>
 612 <DT><B>Specified by:</B><DD><CODE>retainAll</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 613 </DD>
 614 <DD><DL>
 615 </DL>
 616 </DD>
 617 </DL>
 618 <HR>
 619
 620 <A NAME="size()"><!-- --></A><H3>
 621 size</H3>
 622 <PRE>
 623 public int <B>size</B>()</PRE>
 624 <DL>
 625 <DD><DL>
 626 <DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Collection</CODE></DL>
 627 </DD>
 628 <DD><DL>
 629 </DL>
 630 </DD>
 631 </DL>
 632 <HR>
 633
 634 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
 635 equals</H3>
 636 <PRE>
 637 public boolean <B>equals</B>(java.lang.Object&nbsp;object)</PRE>
 638 <DL>
 639 <DD><DL>
 640 <DT><B>Specified by:</B><DD><CODE>equals</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
 641 </DD>
 642 <DD><DL>
 643 </DL>
 644 </DD>
 645 </DL>
 646 <HR>
 647
 648 <A NAME="hashCode()"><!-- --></A><H3>
 649 hashCode</H3>
 650 <PRE>
 651 public int <B>hashCode</B>()</PRE>
 652 <DL>
 653 <DD><DL>
 654 <DT><B>Specified by:</B><DD><CODE>hashCode</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
 655 </DD>
 656 <DD><DL>
 657 </DL>
 658 </DD>
 659 </DL>
 660 <HR>
 661
 662 <A NAME="toString()"><!-- --></A><H3>
 663 toString</H3>
 664 <PRE>
 665 public java.lang.String <B>toString</B>()</PRE>
 666 <DL>
 667 <DD><DL>
 668 <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
 669 </DD>
 670 <DD><DL>
 671 </DL>
 672 </DD>
 673 </DL>
 674 <!-- ========= END OF CLASS DATA ========= -->
 675 <HR>
 676
 677
 678 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 679 <A NAME="navbar_bottom"><!-- --></A>
 680 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 681 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 682 <TR>
 683 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 684 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 685 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 686   <TR ALIGN="center" VALIGN="top">
 687   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 688   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 689   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 690   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SynchronizedCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 691   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 692   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 693   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 694   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 695   </TR>
 696 </TABLE>
 697 </TD>
 698 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 699 </EM>
 700 </TD>
 701 </TR>
 702
 703 <TR>
 704 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 705 &nbsp;<A HREF="../../../../../org/apache/commons/collections/collection/PredicatedCollection.html" title="class in org.apache.commons.collections.collection"><B>PREV CLASS</B></A>&nbsp;
 706 &nbsp;<A HREF="../../../../../org/apache/commons/collections/collection/TransformedCollection.html" title="class in org.apache.commons.collections.collection"><B>NEXT CLASS</B></A></FONT></TD>
 707 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 708   <A HREF="../../../../../index.html?org/apache/commons/collections/collection/SynchronizedCollection.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 709 &nbsp;<A HREF="SynchronizedCollection.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 710 &nbsp;<SCRIPT type="text/javascript">
 711   <!--
 712   if(window==top) {
 713     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 714   }
 715   //-->
 716 </SCRIPT>
 717 <NOSCRIPT>
 718   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 719 </NOSCRIPT>
 720
 721
 722 </FONT></TD>
 723 </TR>
 724 <TR>
 725 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 726   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 727 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 728 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 729 </TR>
 730 </TABLE>
 731 <A NAME="skip-navbar_bottom"></A>
 732 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 733
 734 <HR>
 735 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
 736 </BODY>
 737 </HTML>