I_CmsJspTagParamParent


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/jsp/I_CmsJspTagParamParent.java,v $
3    * Date   : $Date: 2005/06/23 11:11:24 $
4    * Version: $Revision: 1.8 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   * 
31   * This file is based on:
32   * org.apache.taglibs.standard.tag.common.core.ParamParrent
33   * from the Apache JSTL 1.0 implmentation.
34   * 
35   * The Apache Software License, Version 1.1
36   *
37   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
38   * reserved.
39   *
40   * Redistribution and use in source and binary forms, with or without
41   * modification, are permitted provided that the following conditions
42   * are met:
43   *
44   * 1. Redistributions of source code must retain the above copyright
45   *    notice, this list of conditions and the following disclaimer. 
46   *
47   * 2. Redistributions in binary form must reproduce the above copyright
48   *    notice, this list of conditions and the following disclaimer in
49   *    the documentation and/or other materials provided with the
50   *    distribution.
51   *
52   * 3. The end-user documentation included with the redistribution, if
53   *    any, must include the following acknowlegement:  
54   *       "This product includes software developed by the 
55   *        Apache Software Foundation (http://www.apache.org/)."
56   *    Alternately, this acknowlegement may appear in the software itself,
57   *    if and wherever such third-party acknowlegements normally appear.
58   *
59   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
60   *    Foundation" must not be used to endorse or promote products derived
61   *    from this software without prior written permission. For written 
62   *    permission, please contact apache@apache.org.
63   *
64   * 5. Products derived from this software may not be called "Apache"
65   *    nor may "Apache" appear in their names without prior written
66   *    permission of the Apache Group.
67   *
68   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
69   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
70   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
71   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
72   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
73   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
74   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
75   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
76   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
77   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
78   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
79   * SUCH DAMAGE.
80   * ====================================================================
81   *
82   * This software consists of voluntary contributions made by many
83   * individuals on behalf of the Apache Software Foundation.  For more
84   * information on the Apache Software Foundation, please see
85   * <http://www.apache.org/>.
86   *
87   */
88  
89  package org.opencms.jsp;
90  
91  /**
92   * Interface for tag handlers implementing valid parent tags for
93   * &lt;c:param&gt;.<p>
94   *
95   * @author Shawn Bayern 
96   * 
97   * @version $Revision: 1.8 $ 
98   * 
99   * @since 6.0.0 
100  */
101 public interface I_CmsJspTagParamParent {
102 
103     /**
104      * Add a parameter to this tag.  The intent is that the
105      * &lt;param&gt; subtag will call this to register parameters.
106      * Assumes that 'name' and 'value' are appropriately encoded and do
107      * not contain any meaningful metacharacters; in order words, escaping
108      * is the responsibility of the caller.
109      *
110      * @param name the name of the parameter
111      * @param value the value of the parameter
112      *
113      * @see CmsJspTagParam
114      */
115     void addParameter(String   name, String   value);
116 
117 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags