KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > tool > TemplateLinkWithSlash


1 package org.apache.turbine.tool;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import org.apache.turbine.RunData;
58
59 /**
60  * This class allows one to specify paths in the setPage method
61  * using '/' slash as opposed to the ',' used in TemplateLink.
62  * It is less efficient as the '/' are converted to ',' to avoid
63  * problems parsing the pathinfo after conversion in a web server.
64  *
65  * It is recommended that projects standardize on using the ','
66  * separator and use TemplateLink. But this class is available for
67  * those who do not mind the inefficiency.
68  *
69  * @author <a HREF="jmcnally@collab.net">John D. McNally</a>
70  * @version $Id: TemplateLinkWithSlash.java,v 1.1 2002/06/01 22:05:28 jvanzyl Exp $
71  */
72 public class TemplateLinkWithSlash
73     extends TemplateLink
74 {
75     /**
76      * Default constructor
77      * <p>
78      * The init method must be called before use.
79      */
80     public TemplateLinkWithSlash()
81     {
82     }
83
84     /**
85      * Constructor.
86      *
87      * @param data a Turbine RunData object.
88      */
89     public TemplateLinkWithSlash(RunData data)
90     {
91         super(data);
92     }
93
94     /**
95      * Sets the template variable used by the Template Service.
96      * This method allows slashes '/' as the path separator.
97      *
98      * @param t A String with the template name.
99      * @return A TemplateLink.
100      */
101     public TemplateLink setPage(String JavaDoc t)
102     {
103         super.setPage( t.replace('/', ',') );
104         return this;
105     }
106 }
107
108
109
Popular Tags