dlr 02/02/15 15:37:52
Modified: src/java/org/apache/velocity/app/event
ReferenceInsertionEventHandler.java
Log:
JavaDoc'd refernceInsert().
Revision Changes Path
1.2 +11 -1
jakarta-velocity/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java
Index: ReferenceInsertionEventHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-velocity/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- ReferenceInsertionEventHandler.java 20 May 2001 19:48:56 -0000 1.1
+++ ReferenceInsertionEventHandler.java 15 Feb 2002 23:37:52 -0000 1.2
@@ -60,9 +60,19 @@
* Please return an Object that will toString() nicely :)
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Geir Magnusson Jr.</a>
- * @version $Id: ReferenceInsertionEventHandler.java,v 1.1 2001/05/20 19:48:56
geirm Exp $
+ * @version $Id: ReferenceInsertionEventHandler.java,v 1.2 2002/02/15 23:37:52 dlr
Exp $
*/
public interface ReferenceInsertionEventHandler extends EventHandler
{
+ /**
+ * A call-back which is executed during Velocity merge before a
+ * reference value is inserted into the output stream.
+ *
+ * @param reference Reference from template about to be inserted.
+ * @param value Value about to be inserted (after its
+ * <code>toString()</code> method is called).
+ * @return Object on which <code>toString()</code> should be
+ * called for output.
+ */
public Object referenceInsert( String reference, Object value );
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
