1 package org.apache.velocity.app.event; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.apache.velocity.context.Context; 23 24 /** 25 * Reference 'Stream insertion' event handler. Called with object 26 * that will be inserted into stream via value.toString(). 27 * 28 * Please return an Object that will toString() nicely :) 29 * 30 * @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a> 31 * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> 32 * @version $Id$ 33 */ 34 public interface ReferenceInsertionEventHandler extends EventHandler 35 { 36 /** 37 * A call-back which is executed during Velocity merge before a reference 38 * value is inserted into the output stream. All registered 39 * ReferenceInsertionEventHandlers are called in sequence. If no 40 * ReferenceInsertionEventHandlers are are registered then reference value 41 * is inserted into the output stream as is. 42 * 43 * 44 * @param context current context 45 * @param reference Reference from template about to be inserted. 46 * @param value Value about to be inserted (after its <code>toString()</code> 47 * method is called). 48 * @return Object on which <code>toString()</code> should be called for 49 * output. 50 */ referenceInsert(Context context, String reference, Object value)51 Object referenceInsert(Context context, String reference, Object value); 52 53 } 54