ReferenceInsertionEventHandler


1   package org.apache.velocity.app.event;
2   /*
3    * Copyright 2001,2004 The Apache Software Foundation.
4    * 
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /**
19   *  Reference 'Stream insertion' event handler.  Called with object
20   *  that will be inserted into stream via value.toString().
21   *
22   *  Please return an Object that will toString() nicely :)
23   *
24   * @author <a HREF="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
25   * @version $Id: ReferenceInsertionEventHandler.java,v 1.2.8.1 2004/03/03 23:22:53 geirm Exp $
26   */
27  public interface  ReferenceInsertionEventHandler extends EventHandler
28  {
29      /**
30       * A call-back which is executed during Velocity merge before a
31       * reference value is inserted into the output stream.
32       *
33       * @param reference Reference from template about to be inserted.
34       * @param value Value about to be inserted (after its
35       * <code>toString()</code> method is called).
36       * @return Object on which <code>toString()</code> should be
37       * called for output.
38       */
39      public Object   referenceInsert( String   reference, Object   value  );
40  }
41

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags