cvs commit: jakarta-commons/collections RELEASE-NOTES.html build.xml RELEASE-NOTES-2.1.html RELEASE-NOTES-2.0.html

[sc...@apache.org]

scolebourne    2003/09/29 15:46:15

  Modified:    collections build.xml
  Added:       collections RELEASE-NOTES.html
  Removed:     collections RELEASE-NOTES-2.1.html RELEASE-NOTES-2.0.html
  Log:
  Start the process of writing 3.0 release notes - iterator package
  
  Revision  Changes    Path
  1.41      +2 -2      jakarta-commons/collections/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/build.xml,v
  retrieving revision 1.40
  retrieving revision 1.41
  diff -u -r1.40 -r1.41
  --- build.xml	27 Sep 2003 10:54:06 -0000	1.40
  +++ build.xml	29 Sep 2003 22:46:15 -0000	1.41
  @@ -52,7 +52,7 @@
   
         <!-- The current version number of this component -->
         <property name="component.version" value="2.1"/>
  -      <property name="doc.release.notes" value="RELEASE-NOTES-${component.version}.html"/>
  +      <property name="doc.release.notes" value="RELEASE-NOTES.html"/>
         <property name="doc.status" value="STATUS.html"/>
   
         <property name="test.entry" value="org.apache.commons.collections.TestAll"/>
  
  
  
  1.1                  jakarta-commons/collections/RELEASE-NOTES.html
  
  Index: RELEASE-NOTES.html
  ===================================================================
  <title>RELEASE NOTES: COLLECTIONS 3.0</title>
  
  <center><h2>RELEASE NOTES: COLLECTIONS 3.0</h2></center>
  
  <p><i>Collections 3.0</i> includes a significant number of new collections
  in addition to various bug fixes and refactoring changes. The major additions
  are:
  </p>
  <ul>
  <li><strong>Buffers</strong> - A new collection interface for queues and 
  queue-like things.</li>
  <li><strong>Decorators</strong> - A group of static utility classes that provide
  decorators for other collections</li>
  </ul>
  <p>
  The decorators are found on classes named <code>XxxUtils</code> where Xxx is the
  collection type. The decorators are:
  </p>
  <ul>
  <li><strong>Synchronized</strong> - Synchronized decorators where not provided 
  by <code>Collections</code>.</li>
  <li><strong>Unmodifiable</strong> - Unmodifiable decorators where not provided 
  by <code>Collections</code>.</li>
  <li><strong>Predicated</strong> - Decorators that only allow the addition of an
  element to the collection if it matches a <code>Predicate</code>.</li>
  <li><strong>FixedSize</strong> - Decorators that ensure that the list/map 
  cannot change size.</li>
  <li><strong>Lazy</strong> - Decorators that create objects on demand using a
  <code>Factory</code>.</li>
  </ul>
  <p>
  Access to Iterators and Comparators has also been brought in line, by the provision
  of <code>IteratorUtils</code> and <code>ComparatorUtils</code>.
  </p>
  
  <hr />
  
  <center><h3>
  NEW COLLECTIONS, COMPARATORS, ITERATORS AND UTILITY CLASSES
  </h3></center>
  
  <p>These collections are new to <i>Collections 3.0</i>:</p>
  
  <ul>
  </ul>
  
  <p>These comparators are new to <i>Collections 2.1</i>:</p>
  
  <ul>
  </ul>
  
  <p>These iterators are new to <i>Collections 2.1</i>:</p>
  
  <ul>
  <li><strong>ArrayListIterator</strong> - Provides a ListIterator over an array
      of any type (including primitive arrays).</li>
  
  <li><strong>LoopingIterator</strong> - Provides an Iterator that loops repeatedly
  	over the collection.</li>
  
  <li><strong>ObjectArrayIterator/ListIterator</strong> - 
  	Provides iterators over an Object array.</li>
  
  <li><strong>ResetableIterator/ListIterator</strong> - 
  	Interface that defines a reset() method to reset the iterator back to the start.</li>
  </ul>
  
  <p>These are the new utility classes:</p>
  
  <ul>
  </ul>
  
  
  <hr />
  
  <center><h3>CHANGED CLASSES</h3></center>
  
  <p>These iterators have changed since <i>Collections 2.1</i>:</p>
  
  <ul>
  <li><strong>ArrayIterator</strong> - 
  	This now implements the ResetableIterator interface. It also supports a start index to iterate from.</li>
  
  <li><strong>CollatingIterator</strong> - 
  	The remove() method now throws IllegalStateException not NoSuchElementException.</li>
  
  <li><strong>FilterIterator</strong> - 
  	The remove() method is now supported, with some limitations.</li>
  
  <li><strong>IteratorChain</strong> - 
  	Bug fix for when remove() called before hasNext()/next().</li>
  
  <li><strong>SingletonIterator/ListIterator</strong> - 
  	These now implement the ResetableIterator interface.</li>
  </ul>
  
  
  <hr />
  
  
  <center><h3>REFACTORING</h3></center>
  
  <p><u>Documentation</u></p>
  
  <p>Every class released in 3.0 has been changed in some way.
  This might be simply the update to the Apache license, or it could be improved Javadoc.</p>
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org