Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Source code: com/sitemesh/Decorator.java


1   package com.sitemesh;
2   
3   import java.util.Map;
4   
5   /**
6    * Representation of a Decorator.
7    *
8    * A Decorator is infact a Servlet/JSP, and this is a wrapper to reference it.
9    * An implementation is returned by the {@link com.sitemesh.DecoratorMapper}.
10   *
11   * @author <a href="mailto:joe@truemesh.com">Joe Walnes</a>
12   * @version $Revision: 1.8 $
13   */
14  public interface Decorator {
15  
16    /**
17     * URI of Servlet/JSP to dispatch request to (relative to
18     * web-app context).
19     */
20    String getPage();
21  
22    /**
23     * Name of Decorator. For information purposes only.
24     */
25    String getName();
26  
27    /**
28     * Return init parameter of Decorator.
29     *
30     * @param paramName Key of parameter.
31     * @return Value of parameter or null if not found.
32     */
33    String getInitParam( String paramName );
34  
35  }