Javadoc how to use Predicated classes
bug 29018 git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131730 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne
parent
2666222cf4
commit
a1ef86771c
|
|
@ -99,4 +99,5 @@ No deprecations have occurred.
|
|||
<li>BoundedCollection/UnmodifiableBoundedCollection - reword to avoid misunderstandings</li>
|
||||
<li>Closure/Predicate/Transformer/Factory - Additional javadoc with links</li>
|
||||
<li>ClosureUtils/PredicateUtils/TransformerUtils/FactoryUtils - Additional links to implementations</li>
|
||||
<li>PredicatedXxx - Additional usage explanation [29018]</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -25,11 +25,15 @@ import org.apache.commons.collections.collection.PredicatedCollection;
|
|||
* Decorates another <code>Bag</code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the list, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This bag exists to provide validation for the decorated bag.
|
||||
* It is normally created to decorate an empty bag.
|
||||
* If an object cannot be added to the bag, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the bag.
|
||||
* <pre>Bag bag = PredicatedBag.decorate(new HashBag(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.5 $ $Date: 2004/05/15 12:27:04 $
|
||||
* @version $Revision: 1.6 $ $Date: 2004/05/21 21:38:40 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -24,11 +24,15 @@ import org.apache.commons.collections.SortedBag;
|
|||
* Decorates another <code>SortedBag</code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the list, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This bag exists to provide validation for the decorated bag.
|
||||
* It is normally created to decorate an empty bag.
|
||||
* If an object cannot be added to the bag, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the bag.
|
||||
* <pre>SortedBag bag = PredicatedSortedBag.decorate(new TreeBag(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.5 $ $Date: 2004/05/15 12:27:04 $
|
||||
* @version $Revision: 1.6 $ $Date: 2004/05/21 21:38:40 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -23,11 +23,15 @@ import org.apache.commons.collections.collection.PredicatedCollection;
|
|||
* Decorates another <code>Buffer</code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the collection, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This buffer exists to provide validation for the decorated buffer.
|
||||
* It is normally created to decorate an empty buffer.
|
||||
* If an object cannot be added to the buffer, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the buffer.
|
||||
* <pre>Buffer buffer = PredicatedBuffer.decorate(new UnboundedFifoBuffer(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.4 $ $Date: 2004/05/15 12:33:23 $
|
||||
* @version $Revision: 1.5 $ $Date: 2004/05/21 21:38:48 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -24,11 +24,15 @@ import org.apache.commons.collections.Predicate;
|
|||
* Decorates another <code>Collection</code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the collection, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This collection exists to provide validation for the decorated collection.
|
||||
* It is normally created to decorate an empty collection.
|
||||
* If an object cannot be added to the collection, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the collection.
|
||||
* <pre>Collection coll = PredicatedCollection.decorate(new ArrayList(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.4 $ $Date: 2004/05/15 12:39:13 $
|
||||
* @version $Revision: 1.5 $ $Date: 2004/05/21 21:38:40 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -28,10 +28,15 @@ import org.apache.commons.collections.iterators.AbstractListIteratorDecorator;
|
|||
* Decorates another <code>List</code> to validate that all additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* This list exists to provide validation for the decorated list.
|
||||
* It is normally created to decorate an empty list.
|
||||
* If an object cannot be added to the list, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the list.
|
||||
* <pre>List list = PredicatedList.decorate(new ArrayList(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.3 $ $Date: 2004/02/18 01:12:26 $
|
||||
* @version $Revision: 1.4 $ $Date: 2004/05/21 21:38:40 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -28,13 +28,17 @@ import org.apache.commons.collections.Predicate;
|
|||
* Decorates another <code>Map</code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the map, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This map exists to provide validation for the decorated map.
|
||||
* It is normally created to decorate an empty map.
|
||||
* If an object cannot be added to the map, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null keys are added to the map.
|
||||
* <pre>Map map = PredicatedSet.decorate(new HashMap(), NotNullPredicate.INSTANCE, null);</pre>
|
||||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.11 $ $Date: 2004/05/07 23:11:04 $
|
||||
* @version $Revision: 1.12 $ $Date: 2004/05/21 21:38:49 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -24,13 +24,17 @@ import org.apache.commons.collections.Predicate;
|
|||
* Decorates another <code>SortedMap </code> to validate that additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* If an object cannot be added to the map, an IllegalArgumentException
|
||||
* is thrown.
|
||||
* This map exists to provide validation for the decorated map.
|
||||
* It is normally created to decorate an empty map.
|
||||
* If an object cannot be added to the map, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null keys are added to the map.
|
||||
* <pre>SortedMap map = PredicatedSortedSet.decorate(new TreeMap(), NotNullPredicate.INSTANCE, null);</pre>
|
||||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.6 $ $Date: 2004/04/09 10:36:01 $
|
||||
* @version $Revision: 1.7 $ $Date: 2004/05/21 21:38:49 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -24,10 +24,15 @@ import org.apache.commons.collections.collection.PredicatedCollection;
|
|||
* Decorates another <code>Set</code> to validate that all additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* This set exists to provide validation for the decorated set.
|
||||
* It is normally created to decorate an empty set.
|
||||
* If an object cannot be added to the set, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the set.
|
||||
* <pre>Set set = PredicatedSet.decorate(new HashSet(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.3 $ $Date: 2004/02/18 01:14:27 $
|
||||
* @version $Revision: 1.4 $ $Date: 2004/05/21 21:38:42 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -24,10 +24,15 @@ import org.apache.commons.collections.Predicate;
|
|||
* Decorates another <code>SortedSet</code> to validate that all additions
|
||||
* match a specified predicate.
|
||||
* <p>
|
||||
* This set exists to provide validation for the decorated set.
|
||||
* It is normally created to decorate an empty set.
|
||||
* If an object cannot be added to the set, an IllegalArgumentException is thrown.
|
||||
* <p>
|
||||
* One usage would be to ensure that no null entries are added to the set.
|
||||
* <pre>SortedSet set = PredicatedSortedSet.decorate(new TreeSet(), NotNullPredicate.INSTANCE);</pre>
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.3 $ $Date: 2004/02/18 01:14:27 $
|
||||
* @version $Revision: 1.4 $ $Date: 2004/05/21 21:38:42 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
Loading…
Reference in New Issue