org.apache.velocity.app.event
Interface ReferenceInsertionEventHandler

All Superinterfaces:

EventHandler

All Known Implementing Classes:

EventCartridge, EventHandlingTestCase, Test

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 191743 2005-06-21 23:22:20Z dlr $

Author:

Geir Magnusson Jr.

Method Summary

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.

Method Detail

referenceInsert

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.