View Javadoc

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  import org.apache.velocity.util.ContextAware;
24  
25  /**
26   *  Reference 'Stream insertion' event handler.  Called with object
27   *  that will be inserted into stream via value.toString().
28   *
29   *  Please return an Object that will toString() nicely :)
30   *
31   * @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a>
32   * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
33   * @version $Id: ReferenceInsertionEventHandler.java 685685 2008-08-13 21:43:27Z nbubna $
34   */
35  public interface  ReferenceInsertionEventHandler extends EventHandler
36  {
37      /**
38       * A call-back which is executed during Velocity merge before a reference
39       * value is inserted into the output stream. All registered
40       * ReferenceInsertionEventHandlers are called in sequence. If no
41       * ReferenceInsertionEventHandlers are are registered then reference value
42       * is inserted into the output stream as is.
43       *
44       * @param reference Reference from template about to be inserted.
45       * @param value Value about to be inserted (after its <code>toString()</code>
46       *            method is called).
47       * @return Object on which <code>toString()</code> should be called for
48       *         output.
49       */
50      public Object referenceInsert( String reference, Object value  );
51  
52      /**
53       * Defines the execution strategy for referenceInsert
54       * @since 1.5
55       */
56      static class referenceInsertExecutor implements EventHandlerMethodExecutor
57      {
58          private Context context;
59          private String reference;
60          private Object value;
61  
62          referenceInsertExecutor(
63                  Context context, 
64                  String reference, 
65                  Object value)
66          {
67              this.context = context;
68              this.reference = reference;
69              this.value = value;
70          }
71  
72          /**
73           * Call the method referenceInsert()
74           *  
75           * @param handler call the appropriate method on this handler
76           */
77          public void execute(EventHandler handler)
78          {
79              ReferenceInsertionEventHandler eh = (ReferenceInsertionEventHandler) handler;
80              
81              if (eh instanceof ContextAware)
82                  ((ContextAware) eh).setContext(context);
83  
84              /**
85               * Every successive call will alter the same value
86               */
87              value = ((ReferenceInsertionEventHandler) handler).referenceInsert(reference, value); 
88          }
89  
90          public Object getReturnValue()
91          {
92              return value;
93          }
94  
95          /**
96           * Continue to end of event handler iteration
97           * 
98           * @return always returns false
99           */
100         public boolean isDone()
101         {
102             return false;
103         }        
104     }
105 
106 }