View Javadoc

1   package org.apache.velocity.context;
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.app.event.EventCartridge;
23  
24  /**
25   *  Interface for event support.  Note that this is a public internal
26   *  interface, as it is something that will be accessed from outside
27   *  of the .context package.
28   *
29   *  @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
30   *  @version $Id: InternalEventContext.java 463298 2006-10-12 16:10:32Z henning $
31   */
32  public interface InternalEventContext
33  {
34      /**
35       * @param ec
36       * @return The old EventCartridge.
37       */
38      public EventCartridge attachEventCartridge( EventCartridge ec);
39  
40      /**
41       * @return The current EventCartridge.
42       */
43      public EventCartridge getEventCartridge();
44  }