cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/decorators package.html

[sc...@apache.org]

scolebourne    2003/09/03 16:53:27

  Modified:    collections/src/java/org/apache/commons/collections/decorators
                        package.html
  Log:
  Improve documentation
  
  Revision  Changes    Path
  1.2       +4 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	10 May 2003 12:51:06 -0000	1.1
  +++ package.html	3 Sep 2003 23:53:27 -0000	1.2
  @@ -9,16 +9,17 @@
   <li>Unmodifiable - ensures the collection cannot be altered
   <li>Predicated - ensures that only elements that are valid according to a predicate can be added
   <li>Typed - ensures that only elements that are of a specific type can be added
  -<li>Lazy - creates objects in the collection on demand
  -<li>FixedSize - ensures that the size of the collection cannot change
   <li>Blocking - blocks until data available when calling get() on an empty collection
  +<li>FixedSize - ensures that the size of the collection cannot change
  +<li>Lazy - creates objects in the collection on demand
  +<li>Ordered - ensures that insertion order is remembered in a Map/Set
   </ul>
   <p>
   Each collection can be constructed using a static <code>decorate()</code> method on
   the class. They can also be constructed from the <code>XxxUtils</code> class where
   Xxx is the collection type.
   <pre>
  -List stringOnlyList = TypedList(new ArrayList(), String.class);
  +List stringOnlyList = TypedList.decorate(new ArrayList(), String.class);
   List otherStringOnlyList = ListUtils.typedList(new ArrayList(), String.class);
   </pre>
   </BODY>