org.apache.velocity.app.event

Interface ReferenceInsertionEventHandler

public interface ReferenceInsertionEventHandler extends EventHandler

Reference 'Stream insertion' event handler. Called with object that will be inserted into stream via value.toString(). Please return an Object that will toString() nicely :)

Version: $Id: ReferenceInsertionEventHandler.java,v 1.2.8.1 2004/03/03 23:22:53 geirm Exp $

Author: Geir Magnusson Jr.

Method Summary
ObjectreferenceInsert(String reference, Object value)
A call-back which is executed during Velocity merge before a reference value is inserted into the output stream.

Method Detail

referenceInsert

public Object referenceInsert(String reference, Object value)
A call-back which is executed during Velocity merge before a reference value is inserted into the output stream.

Parameters: reference Reference from template about to be inserted. value Value about to be inserted (after its toString() method is called).

Returns: Object on which toString() should be called for output.

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.