Interface ReferenceInsertionEventHandler

All Superinterfaces:
EventHandler

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 685685 2008-08-13 21:43:27Z nbubna $
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Defines the execution strategy for referenceInsert
  • Method Summary

    Modifier and Type
    Method
    Description
    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 Details

    • 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. All registered ReferenceInsertionEventHandlers are called in sequence. If no ReferenceInsertionEventHandlers are are registered then reference value is inserted into the output stream as is.
      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.