geirm 01/04/08 14:40:47
Modified: xdocs changes.xml developer-guide.xml
docs changes.html developer-guide.html
Log:
Changes, and notes on the Enumeration in #foreach()
Revision Changes Path
1.31 +7 -0 jakarta-velocity/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/changes.xml,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- changes.xml 2001/04/04 10:45:04 1.30
+++ changes.xml 2001/04/08 21:40:45 1.31
@@ -43,6 +43,13 @@
Added 'throws Exception' to handleRequest() in VelocityServlet.java
(suggestion from Christoph Reck) (gmj)
</li>
+ <li>
+ Updates to README.txt and examples/README.txt as suggested by Kent Johnson (gmj)
+ </li>
+ <li>
+ Added Enumerator as a valid iteration type for #foreach() - added warnings
+ to use of same to documentation. (gmj)
+ </li>
</ul>
</subsection>
1.36 +14 -0 jakarta-velocity/xdocs/developer-guide.xml
Index: developer-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/developer-guide.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- developer-guide.xml 2001/04/02 02:29:17 1.35
+++ developer-guide.xml 2001/04/08 21:40:45 1.36
@@ -433,7 +433,21 @@
blocks after the first will fail, as the Iterator doesn't reset.
</li>
+<li> <code>java.util.Enumeration</code> USE WITH CAUTION : Like
+<code>java.util.Iterator</code>, this is currently
+supported only provisionally - the issue of concern is the
+'non-resettablity' of the Enumeration. If a 'naked' Enumeration
+is placed into the context, and used in more than one #foreach(),
+subsequent #foreach() blocks after the first will fail,
+as the Enumeration doesn't reset.
+</li>
+
</ul>
+
+In the case of the <code>Iterator</code> and <code>Enumeration</code>, it is
+recommended that they are placed in the context only when it cannot be avoided,
+and you should let Velocity find the appropriate reusable iterative interface when
+that is sufficient and possible.
</p>
<p>
1.30 +7 -0 jakarta-velocity/docs/changes.html
Index: changes.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/changes.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- changes.html 2001/04/04 10:45:05 1.29
+++ changes.html 2001/04/08 21:40:46 1.30
@@ -145,6 +145,13 @@
Added 'throws Exception' to handleRequest() in VelocityServlet.java
(suggestion from Christoph Reck) (gmj)
</li>
+ <li>
+ Updates to README.txt and examples/README.txt as suggested by Kent Johnson (gmj)
+ </li>
+ <li>
+ Added Enumerator as a valid iteration type for #foreach() - added warnings
+ to use of same to documentation. (gmj)
+ </li>
</ul>
</blockquote>
</td></tr>
1.52 +14 -0 jakarta-velocity/docs/developer-guide.html
Index: developer-guide.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/developer-guide.html,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -r1.51 -r1.52
--- developer-guide.html 2001/04/02 02:29:17 1.51
+++ developer-guide.html 2001/04/08 21:40:46 1.52
@@ -589,7 +589,21 @@
blocks after the first will fail, as the Iterator doesn't reset.
</li>
+<li> <code>java.util.Enumeration</code> USE WITH CAUTION : Like
+<code>java.util.Iterator</code>, this is currently
+supported only provisionally - the issue of concern is the
+'non-resettablity' of the Enumeration. If a 'naked' Enumeration
+is placed into the context, and used in more than one #foreach(),
+subsequent #foreach() blocks after the first will fail,
+as the Enumeration doesn't reset.
+</li>
+
</ul>
+
+In the case of the <code>Iterator</code> and <code>Enumeration</code>, it is
+recommended that they are placed in the context only when it cannot be avoided,
+and you should let Velocity find the appropriate reusable iterative interface when
+that is sufficient and possible.
</p>
<p>
There are good reasons to use the <code>java.util.Iterator</code> interface
