View Javadoc

1   /*
2    * $Id: TagLibrary.java 651946 2008-04-27 13:41:38Z apetrelli $
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  package org.apache.struts2.views;
23  
24  import java.util.List;
25  
26  import javax.servlet.http.HttpServletRequest;
27  import javax.servlet.http.HttpServletResponse;
28  
29  import com.opensymphony.xwork2.util.ValueStack;
30  
31  /***
32   * Provides Velocity and Freemarker implementation classes for a tag library
33   */
34  public interface TagLibrary {
35  
36      /***
37       * Gets a Java object that contains getters for the tag library's Freemarker models.  
38       * Called once per Freemarker template processing.
39       * 
40       * @param stack The current value stack
41       * @param req The HTTP request
42       * @param res The HTTP response
43       * @return The Java object containing the Freemarker model getter methods
44       */
45      public Object getFreemarkerModels(ValueStack stack, HttpServletRequest req, HttpServletResponse res);
46      
47      /***
48       * Gets a list of Velocity directive classes for the tag library.  Called once on framework
49       * startup when initializing Velocity.
50       * 
51       * @return A list of Velocity directive classes
52       */
53      public List<Class> getVelocityDirectiveClasses();
54  }