1 package org.apache.velocity.util;
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 /**
26 * Event handlers implementing this interface will automatically
27 * have the method setContext called before each event. This
28 * allows the event handler to use information in the latest context
29 * when responding to the event.
30 *
31 * <P>Important Note: Only local event handlers attached to the context
32 * (as opposed to global event handlers initialized in the velocity.properties
33 * file) should implement ContextAware. Since global event handlers are
34 * singletons individual requests will not be able to count on the
35 * correct context being loaded before a request.
36 *
37 * @author <a href="mailto:wglass@wglass@forio.com">Will Glass-Husain</a>
38 * @version $Id: ContextAware.java 685685 2008-08-13 21:43:27Z nbubna $
39 * @since 1.5
40 */
41 public interface ContextAware
42 {
43 /**
44 * Initialize the EventHandler.
45 * @param context
46 */
47 public void setContext( Context context );
48
49 }