01: package org.apache.velocity.util;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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: * Event handlers implementing this interface will automatically
26: * have the method setContext called before each event. This
27: * allows the event handler to use information in the latest context
28: * when responding to the event.
29: *
30: * <P>Important Note: Only local event handlers attached to the context
31: * (as opposed to global event handlers initialized in the velocity.properties
32: * file) should implement ContextAware. Since global event handlers are
33: * singletons individual requests will not be able to count on the
34: * correct context being loaded before a request.
35: *
36: * @author <a href="mailto:wglass@wglass@forio.com">Will Glass-Husain</a>
37: * @version $Id: ContextAware.java 463298 2006-10-12 16:10:32Z henning $
38: */
39: public interface ContextAware {
40: /**
41: * Initialize the EventHandler.
42: * @param context
43: */
44: public void setContext(Context context);
45:
46: }
|