[ephemerata.git] / KezvhLib / lib / org.apache.commons.collections / apidocs / org / apache / commons / collections / SetUtils.html
| blob | 9ea2eb2e1fe2cf06a1a8784be60b60d6928f5b8b |
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:17 BST 2008 -->
7 <TITLE>
8 SetUtils (Commons Collections 3.2.1 API)
9 </TITLE>
16 function windowTitle()
17 {
19 }
20 </SCRIPT>
21 <NOSCRIPT>
22 </NOSCRIPT>
24 </HEAD>
29 <!-- ========= START OF TOP NAVBAR ======= -->
33 <TR>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SetUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
46 </TR>
47 </TABLE>
48 </TD>
50 </EM>
51 </TD>
52 </TR>
54 <TR>
56 <A HREF="../../../../org/apache/commons/collections/SequencedHashMap.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>
57 <A HREF="../../../../org/apache/commons/collections/SortedBag.html" title="interface in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
59 <A HREF="../../../../index.html?org/apache/commons/collections/SetUtils.html" target="_top"><B>FRAMES</B></A>
62 <!--
63 if(window==top) {
64 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
65 }
66 //-->
67 </SCRIPT>
68 <NOSCRIPT>
70 </NOSCRIPT>
73 </FONT></TD>
74 </TR>
75 <TR>
77 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
80 </TR>
81 </TABLE>
83 <!-- ========= END OF TOP NAVBAR ========= -->
85 <HR>
86 <!-- ======== START OF CLASS DATA ======== -->
87 <H2>
89 org.apache.commons.collections</FONT>
90 <BR>
91 Class SetUtils</H2>
92 <PRE>
93 java.lang.Object
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.collections.SetUtils</B>
95 </PRE>
96 <HR>
97 <DL>
99 </PRE>
101 <P>
102 Provides utility methods and decorators for
104 <P>
106 <P>
107 <DL>
114 </DL>
115 <HR>
117 <P>
118 <!-- =========== FIELD SUMMARY =========== -->
125 </TR>
129 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#EMPTY_SET">EMPTY_SET</A></B></CODE>
131 <BR>
133 </TR>
137 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#EMPTY_SORTED_SET">EMPTY_SORTED_SET</A></B></CODE>
139 <BR>
140 An empty unmodifiable sorted set.</TD>
141 </TR>
142 </TABLE>
143
144 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
151 </TR>
153 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#SetUtils()">SetUtils</A></B>()</CODE>
155 <BR>
156 <code>SetUtils</code> should not normally be instantiated.</TD>
157 </TR>
158 </TABLE>
159
160 <!-- ========== METHOD SUMMARY =========== -->
167 </TR>
171 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#hashCodeForSet(java.util.Collection)">hashCodeForSet</A></B>(java.util.Collection set)</CODE>
173 <BR>
174 Generates a hash code using the algorithm specified in
176 </TR>
180 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#isEqualSet(java.util.Collection, java.util.Collection)">isEqualSet</A></B>(java.util.Collection set1,
183 <BR>
184 Tests two sets for equality as per the <code>equals()</code> contract
186 </TR>
190 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#orderedSet(java.util.Set)">orderedSet</A></B>(java.util.Set set)</CODE>
192 <BR>
193 Returns a set that maintains the order of elements that are added
194 backed by the given set.</TD>
195 </TR>
199 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#predicatedSet(java.util.Set, org.apache.commons.collections.Predicate)">predicatedSet</A></B>(java.util.Set set,
200 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> predicate)</CODE>
202 <BR>
203 Returns a predicated (validating) set backed by the given set.</TD>
204 </TR>
208 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#predicatedSortedSet(java.util.SortedSet, org.apache.commons.collections.Predicate)">predicatedSortedSet</A></B>(java.util.SortedSet set,
209 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> predicate)</CODE>
211 <BR>
212 Returns a predicated (validating) sorted set backed by the given sorted set.</TD>
213 </TR>
217 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#synchronizedSet(java.util.Set)">synchronizedSet</A></B>(java.util.Set set)</CODE>
219 <BR>
220 Returns a synchronized set backed by the given set.</TD>
221 </TR>
225 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#synchronizedSortedSet(java.util.SortedSet)">synchronizedSortedSet</A></B>(java.util.SortedSet set)</CODE>
227 <BR>
228 Returns a synchronized sorted set backed by the given sorted set.</TD>
229 </TR>
233 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#transformedSet(java.util.Set, org.apache.commons.collections.Transformer)">transformedSet</A></B>(java.util.Set set,
234 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformer)</CODE>
236 <BR>
237 Returns a transformed set backed by the given set.</TD>
238 </TR>
242 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#transformedSortedSet(java.util.SortedSet, org.apache.commons.collections.Transformer)">transformedSortedSet</A></B>(java.util.SortedSet set,
243 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformer)</CODE>
245 <BR>
246 Returns a transformed sorted set backed by the given set.</TD>
247 </TR>
251 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#typedSet(java.util.Set, java.lang.Class)">typedSet</A></B>(java.util.Set set,
254 <BR>
255 Returns a typed set backed by the given set.</TD>
256 </TR>
260 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#typedSortedSet(java.util.SortedSet, java.lang.Class)">typedSortedSet</A></B>(java.util.SortedSet set,
263 <BR>
264 Returns a typed sorted set backed by the given set.</TD>
265 </TR>
269 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#unmodifiableSet(java.util.Set)">unmodifiableSet</A></B>(java.util.Set set)</CODE>
271 <BR>
272 Returns an unmodifiable set backed by the given set.</TD>
273 </TR>
277 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/SetUtils.html#unmodifiableSortedSet(java.util.SortedSet)">unmodifiableSortedSet</A></B>(java.util.SortedSet set)</CODE>
279 <BR>
280 Returns an unmodifiable sorted set backed by the given sorted set.</TD>
281 </TR>
282 </TABLE>
287 </TR>
289 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
290 </TR>
291 </TABLE>
292
293 <P>
295 <!-- ============ FIELD DETAIL =========== -->
302 </TR>
303 </TABLE>
306 EMPTY_SET</H3>
307 <PRE>
309 <DL>
310 <DD>An empty unmodifiable set.
312 and is provided for completeness.
313 <P>
314 <DL>
315 </DL>
316 </DL>
317 <HR>
320 EMPTY_SORTED_SET</H3>
321 <PRE>
323 <DL>
324 <DD>An empty unmodifiable sorted set.
325 This is not provided in the JDK.
326 <P>
327 <DL>
328 </DL>
329 </DL>
331 <!-- ========= CONSTRUCTOR DETAIL ======== -->
338 </TR>
339 </TABLE>
342 SetUtils</H3>
343 <PRE>
345 <DL>
347 <P>
348 </DL>
350 <!-- ============ METHOD DETAIL ========== -->
357 </TR>
358 </TABLE>
361 isEqualSet</H3>
362 <PRE>
365 <DL>
368 <p>
370 extend AbstractSet. The method takes Collection instances to enable other
371 collection types to use the Set implementation algorithm.
372 <p>
373 The relevant text (slightly paraphrased as this is a static method) is:
374 <blockquote>
375 <p>Two sets are considered equal if they have
376 the same size, and every member of the first set is contained in
379 interface.</p>
381 <p>
382 This implementation first checks if the two sets are the same object:
384 identical in size; if not, it returns false. If so, it returns
386 </blockquote>
387 <P>
388 <DD><DL>
389 <DT><B>Parameters:</B><DD><CODE>set1</CODE> - the first set, may be null<DD><CODE>set2</CODE> - the second set, may be null
390 <DT><B>Returns:</B><DD>whether the sets are equal by value comparison<DT><B>See Also:</B><DD><CODE>Set</CODE></DL>
391 </DD>
392 </DL>
393 <HR>
396 hashCodeForSet</H3>
397 <PRE>
399 <DL>
400 <DD>Generates a hash code using the algorithm specified in
402 <p>
404 extend AbstractSet. The method takes Collection instances to enable other
405 collection types to use the Set implementation algorithm.
406 <P>
407 <DD><DL>
408 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to calculate the hash code for, may be null
410 </DD>
411 </DL>
412 <HR>
415 synchronizedSet</H3>
416 <PRE>
418 <DL>
419 <DD>Returns a synchronized set backed by the given set.
420 <p>
421 You must manually synchronize on the returned buffer's iterator to
422 avoid non-deterministic behavior:
424 <pre>
425 Set s = SetUtils.synchronizedSet(mySet);
426 synchronized (s) {
427 Iterator i = s.iterator();
428 while (i.hasNext()) {
429 process (i.next());
430 }
431 }
432 </pre>
434 This method uses the implementation in the decorators subpackage.
435 <P>
436 <DD><DL>
441 </DD>
442 </DL>
443 <HR>
446 unmodifiableSet</H3>
447 <PRE>
449 <DL>
450 <DD>Returns an unmodifiable set backed by the given set.
451 <p>
452 This method uses the implementation in the decorators subpackage.
453 <P>
454 <DD><DL>
459 </DD>
460 </DL>
461 <HR>
463 <A NAME="predicatedSet(java.util.Set, org.apache.commons.collections.Predicate)"><!-- --></A><H3>
464 predicatedSet</H3>
465 <PRE>
467 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> predicate)</PRE>
468 <DL>
469 <DD>Returns a predicated (validating) set backed by the given set.
470 <p>
471 Only objects that pass the test in the given predicate can be added to the set.
472 Trying to add an invalid object results in an IllegalArgumentException.
473 It is important not to use the original set after invoking this method,
474 as it is a backdoor for adding invalid objects.
475 <P>
476 <DD><DL>
477 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to predicate, must not be null<DD><CODE>predicate</CODE> - the predicate for the set, must not be null
481 </DD>
482 </DL>
483 <HR>
486 typedSet</H3>
487 <PRE>
490 <DL>
491 <DD>Returns a typed set backed by the given set.
492 <p>
493 Only objects of the specified type can be added to the set.
494 <P>
495 <DD><DL>
496 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to limit to a specific type, must not be null<DD><CODE>type</CODE> - the type of objects which may be added to the set
498 </DD>
499 </DL>
500 <HR>
502 <A NAME="transformedSet(java.util.Set, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
503 transformedSet</H3>
504 <PRE>
506 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformer)</PRE>
507 <DL>
508 <DD>Returns a transformed set backed by the given set.
509 <p>
510 Each object is passed through the transformer as it is added to the
511 Set. It is important not to use the original set after invoking this
512 method, as it is a backdoor for adding untransformed objects.
513 <P>
514 <DD><DL>
515 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to transform, must not be null<DD><CODE>transformer</CODE> - the transformer for the set, must not be null
519 </DD>
520 </DL>
521 <HR>
524 orderedSet</H3>
525 <PRE>
527 <DL>
528 <DD>Returns a set that maintains the order of elements that are added
529 backed by the given set.
530 <p>
531 If an element is added twice, the order is determined by the first add.
532 The order is observed through the iterator or toArray.
533 <P>
534 <DD><DL>
539 </DD>
540 </DL>
541 <HR>
544 synchronizedSortedSet</H3>
545 <PRE>
546 public static java.util.SortedSet <B>synchronizedSortedSet</B>(java.util.SortedSet set)</PRE>
547 <DL>
548 <DD>Returns a synchronized sorted set backed by the given sorted set.
549 <p>
550 You must manually synchronize on the returned buffer's iterator to
551 avoid non-deterministic behavior:
553 <pre>
554 Set s = SetUtils.synchronizedSet(mySet);
555 synchronized (s) {
556 Iterator i = s.iterator();
557 while (i.hasNext()) {
558 process (i.next());
559 }
560 }
561 </pre>
563 This method uses the implementation in the decorators subpackage.
564 <P>
565 <DD><DL>
570 </DD>
571 </DL>
572 <HR>
575 unmodifiableSortedSet</H3>
576 <PRE>
577 public static java.util.SortedSet <B>unmodifiableSortedSet</B>(java.util.SortedSet set)</PRE>
578 <DL>
579 <DD>Returns an unmodifiable sorted set backed by the given sorted set.
580 <p>
581 This method uses the implementation in the decorators subpackage.
582 <P>
583 <DD><DL>
584 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the sorted set to make unmodifiable, must not be null
588 </DD>
589 </DL>
590 <HR>
592 <A NAME="predicatedSortedSet(java.util.SortedSet, org.apache.commons.collections.Predicate)"><!-- --></A><H3>
593 predicatedSortedSet</H3>
594 <PRE>
596 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> predicate)</PRE>
597 <DL>
598 <DD>Returns a predicated (validating) sorted set backed by the given sorted set.
599 <p>
600 Only objects that pass the test in the given predicate can be added to the set.
601 Trying to add an invalid object results in an IllegalArgumentException.
602 It is important not to use the original set after invoking this method,
603 as it is a backdoor for adding invalid objects.
604 <P>
605 <DD><DL>
606 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the sorted set to predicate, must not be null<DD><CODE>predicate</CODE> - the predicate for the sorted set, must not be null
610 </DD>
611 </DL>
612 <HR>
615 typedSortedSet</H3>
616 <PRE>
619 <DL>
620 <DD>Returns a typed sorted set backed by the given set.
621 <p>
622 Only objects of the specified type can be added to the set.
623 <P>
624 <DD><DL>
625 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to limit to a specific type, must not be null<DD><CODE>type</CODE> - the type of objects which may be added to the set
627 </DD>
628 </DL>
629 <HR>
631 <A NAME="transformedSortedSet(java.util.SortedSet, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
632 transformedSortedSet</H3>
633 <PRE>
635 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformer)</PRE>
636 <DL>
637 <DD>Returns a transformed sorted set backed by the given set.
638 <p>
639 Each object is passed through the transformer as it is added to the
640 Set. It is important not to use the original set after invoking this
641 method, as it is a backdoor for adding untransformed objects.
642 <P>
643 <DD><DL>
644 <DT><B>Parameters:</B><DD><CODE>set</CODE> - the set to transform, must not be null<DD><CODE>transformer</CODE> - the transformer for the set, must not be null
648 </DD>
649 </DL>
650 <!-- ========= END OF CLASS DATA ========= -->
651 <HR>
654 <!-- ======= START OF BOTTOM NAVBAR ====== -->
658 <TR>
663 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
664 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
665 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
666 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SetUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
667 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
668 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
669 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
670 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
671 </TR>
672 </TABLE>
673 </TD>
675 </EM>
676 </TD>
677 </TR>
679 <TR>
681 <A HREF="../../../../org/apache/commons/collections/SequencedHashMap.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>
682 <A HREF="../../../../org/apache/commons/collections/SortedBag.html" title="interface in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
684 <A HREF="../../../../index.html?org/apache/commons/collections/SetUtils.html" target="_top"><B>FRAMES</B></A>
687 <!--
688 if(window==top) {
689 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
690 }
691 //-->
692 </SCRIPT>
693 <NOSCRIPT>
695 </NOSCRIPT>
698 </FONT></TD>
699 </TR>
700 <TR>
702 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
704 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
705 </TR>
706 </TABLE>
708 <!-- ======== END OF BOTTOM NAVBAR ======= -->
710 <HR>
711 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
712 </BODY>
713 </HTML>