1 files changed, 53 insertions, 0 deletions
diff --git a/velocity-engine-core/src/main/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java b/velocity-engine-core/src/main/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java
new file mode 100644
index 00000000..a9e1d660
--- /dev/null
+++ b/velocity-engine-core/src/main/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java
@@ -0,0 +1,53 @@
+package org.apache.velocity.app.event;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.velocity.context.Context;
+
+/**
+ *  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 :)
+ *
+ * @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a>
+ * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
+ * @version $Id$
+ */
+public interface  ReferenceInsertionEventHandler extends EventHandler
+{
+    /**
+     * 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.
+     *
+     *
+     * @param context current context
+     * @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.
+     */
+    Object referenceInsert(Context context, String reference, Object value);
+
+}