KezvhLib/lib/org.apache.commons.collections/apidocs/org/apache/commons/collections/set/package-summary.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:23 BST 2008 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 org.apache.commons.collections.set (Commons Collections 3.2.1 API)
   9 </TITLE>
  10
  11 <META NAME="keywords" CONTENT="org.apache.commons.collections.set package">
  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="org.apache.commons.collections.set (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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/map/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
  57 &nbsp;NEXT PACKAGE</FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../../../index.html?org/apache/commons/collections/set/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="package-summary.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 </TABLE>
  76 <A NAME="skip-navbar_top"></A>
  77 <!-- ========= END OF TOP NAVBAR ========= -->
  78
  79 <HR>
  80 <H2>
  81 Package org.apache.commons.collections.set
  82 </H2>
  83
  84 This package contains implementations of the
  85 <CODE>Set</CODE> and
  86 <CODE>SortedSet</CODE> interfaces.
  87 <P>
  88 <B>See:</B>
  89 <BR>
  90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
  91 <P>
  92
  93 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  94 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  95 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  96 <B>Interface Summary</B></FONT></TH>
  97 </TR>
  98 <TR BGCOLOR="white" CLASS="TableRowColor">
  99 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/CompositeSet.SetMutator.html" title="interface in org.apache.commons.collections.set">CompositeSet.SetMutator</A></B></TD>
 100 <TD>Define callbacks for mutation operations.</TD>
 101 </TR>
 102 </TABLE>
 103 &nbsp;
 104
 105 <P>
 106
 107 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 108 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 109 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 110 <B>Class Summary</B></FONT></TH>
 111 </TR>
 112 <TR BGCOLOR="white" CLASS="TableRowColor">
 113 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/AbstractSerializableSetDecorator.html" title="class in org.apache.commons.collections.set">AbstractSerializableSetDecorator</A></B></TD>
 114 <TD>Serializable subclass of AbstractSetDecorator.</TD>
 115 </TR>
 116 <TR BGCOLOR="white" CLASS="TableRowColor">
 117 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/AbstractSetDecorator.html" title="class in org.apache.commons.collections.set">AbstractSetDecorator</A></B></TD>
 118 <TD>Decorates another <code>Set</code> to provide additional behaviour.</TD>
 119 </TR>
 120 <TR BGCOLOR="white" CLASS="TableRowColor">
 121 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/AbstractSortedSetDecorator.html" title="class in org.apache.commons.collections.set">AbstractSortedSetDecorator</A></B></TD>
 122 <TD>Decorates another <code>SortedSet</code> to provide additional behaviour.</TD>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/CompositeSet.html" title="class in org.apache.commons.collections.set">CompositeSet</A></B></TD>
 126 <TD>Decorates a set of other sets to provide a single unified view.</TD>
 127 </TR>
 128 <TR BGCOLOR="white" CLASS="TableRowColor">
 129 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/ListOrderedSet.html" title="class in org.apache.commons.collections.set">ListOrderedSet</A></B></TD>
 130 <TD>Decorates another <code>Set</code> to ensure that the order of addition
 131  is retained and used by the iterator.</TD>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/MapBackedSet.html" title="class in org.apache.commons.collections.set">MapBackedSet</A></B></TD>
 135 <TD>Decorates a <code>Map</code> to obtain <code>Set</code> behaviour.</TD>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/PredicatedSet.html" title="class in org.apache.commons.collections.set">PredicatedSet</A></B></TD>
 139 <TD>Decorates another <code>Set</code> to validate that all additions
 140  match a specified predicate.</TD>
 141 </TR>
 142 <TR BGCOLOR="white" CLASS="TableRowColor">
 143 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/PredicatedSortedSet.html" title="class in org.apache.commons.collections.set">PredicatedSortedSet</A></B></TD>
 144 <TD>Decorates another <code>SortedSet</code> to validate that all additions
 145  match a specified predicate.</TD>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/SynchronizedSet.html" title="class in org.apache.commons.collections.set">SynchronizedSet</A></B></TD>
 149 <TD>Decorates another <code>Set</code> to synchronize its behaviour for a
 150  multi-threaded environment.</TD>
 151 </TR>
 152 <TR BGCOLOR="white" CLASS="TableRowColor">
 153 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/SynchronizedSortedSet.html" title="class in org.apache.commons.collections.set">SynchronizedSortedSet</A></B></TD>
 154 <TD>Decorates another <code>SortedSet</code> to synchronize its behaviour
 155  for a multi-threaded environment.</TD>
 156 </TR>
 157 <TR BGCOLOR="white" CLASS="TableRowColor">
 158 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/TransformedSet.html" title="class in org.apache.commons.collections.set">TransformedSet</A></B></TD>
 159 <TD>Decorates another <code>Set</code> to transform objects that are added.</TD>
 160 </TR>
 161 <TR BGCOLOR="white" CLASS="TableRowColor">
 162 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/TransformedSortedSet.html" title="class in org.apache.commons.collections.set">TransformedSortedSet</A></B></TD>
 163 <TD>Decorates another <code>SortedSet</code> to transform objects that are added.</TD>
 164 </TR>
 165 <TR BGCOLOR="white" CLASS="TableRowColor">
 166 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/TypedSet.html" title="class in org.apache.commons.collections.set">TypedSet</A></B></TD>
 167 <TD>Decorates another <code>Set</code> to validate that elements
 168  added are of a specific type.</TD>
 169 </TR>
 170 <TR BGCOLOR="white" CLASS="TableRowColor">
 171 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/TypedSortedSet.html" title="class in org.apache.commons.collections.set">TypedSortedSet</A></B></TD>
 172 <TD>Decorates another <code>SortedSet</code> to validate that elements
 173  added are of a specific type.</TD>
 174 </TR>
 175 <TR BGCOLOR="white" CLASS="TableRowColor">
 176 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/UnmodifiableSet.html" title="class in org.apache.commons.collections.set">UnmodifiableSet</A></B></TD>
 177 <TD>Decorates another <code>Set</code> to ensure it can't be altered.</TD>
 178 </TR>
 179 <TR BGCOLOR="white" CLASS="TableRowColor">
 180 <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/commons/collections/set/UnmodifiableSortedSet.html" title="class in org.apache.commons.collections.set">UnmodifiableSortedSet</A></B></TD>
 181 <TD>Decorates another <code>SortedSet</code> to ensure it can't be altered.</TD>
 182 </TR>
 183 </TABLE>
 184 &nbsp;
 185
 186 <P>
 187 <A NAME="package_description"><!-- --></A><H2>
 188 Package org.apache.commons.collections.set Description
 189 </H2>
 190
 191 <P>
 192 <p>
 193 This package contains implementations of the
 194 <CODE>Set</CODE> and
 195 <CODE>SortedSet</CODE> interfaces.
 196 <p>
 197 The implementations are in the form of direct implementations and decorators.
 198 A decorator wraps another implementation of the interface to add some
 199 specific additional functionality.
 200 <p>
 201 The following implementations are provided in the package:
 202 <ul>
 203 <li>CompositeSet - a set that combines multiple sets into one
 204 </ul>
 205 The following decorators are provided in the package:
 206 <ul>
 207 <li>Synchronized - synchronizes method access for multi-threaded environments
 208 <li>Unmodifiable - ensures the collection cannot be altered
 209 <li>Predicated - ensures that only elements that are valid according to a predicate can be added
 210 <li>Typed - ensures that only elements that are of a specific type can be added
 211 <li>Transformed - transforms each element added
 212 <li>ListOrdered - ensures that insertion order is retained
 213 <li>MapBackedSet - a set formed by decorating a Map
 214 </ul>
 215 </pre>
 216 <P>
 217
 218 <P>
 219 <DL>
 220 </DL>
 221 <HR>
 222
 223
 224 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 225 <A NAME="navbar_bottom"><!-- --></A>
 226 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 227 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 228 <TR>
 229 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 230 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 231 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 232   <TR ALIGN="center" VALIGN="top">
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 234   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 237   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 241   </TR>
 242 </TABLE>
 243 </TD>
 244 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 245 </EM>
 246 </TD>
 247 </TR>
 248
 249 <TR>
 250 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 251 &nbsp;<A HREF="../../../../../org/apache/commons/collections/map/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
 252 &nbsp;NEXT PACKAGE</FONT></TD>
 253 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 254   <A HREF="../../../../../index.html?org/apache/commons/collections/set/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 255 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 256 &nbsp;<SCRIPT type="text/javascript">
 257   <!--
 258   if(window==top) {
 259     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 260   }
 261   //-->
 262 </SCRIPT>
 263 <NOSCRIPT>
 264   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 265 </NOSCRIPT>
 266
 267
 268 </FONT></TD>
 269 </TR>
 270 </TABLE>
 271 <A NAME="skip-navbar_bottom"></A>
 272 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 273
 274 <HR>
 275 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
 276 </BODY>
 277 </HTML>