KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > taglibs > request > SetAttributeTag


1 /*
2  * Copyright 1999,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.taglibs.request;
18
19 import java.util.*;
20 import javax.servlet.*;
21 import javax.servlet.http.*;
22 import javax.servlet.jsp.*;
23 import javax.servlet.jsp.tagext.*;
24
25 /**
26  * JSP Tag <b>setattribute</b>, used to set an HttpServletRequest
27  * attribute with name <b>name</b> to a String from the body of the tag.
28  * <p>
29  * JSP Tag Lib Descriptor
30  * <p><pre>
31  * &lt;name&gt;setattribute&lt;/name&gt;
32  * &lt;tagclass&gt;org.apache.taglibs.request.SetAttributeTag&lt;/tagclass&gt;
33  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
34  * &lt;info&gt;Sets an attribute from a request.&lt;/info&gt;
35  * &lt;attribute&gt;
36  * &lt;name&gt;name&lt;/name&gt;
37  * &lt;required&gt;true&lt;/required&gt;
38  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
39  * &lt;/attribute&gt;
40  * </pre>
41  *
42  * @author Glenn Nielsen
43  */
44
45 public class SetAttributeTag extends BodyTagSupport
46 {
47     private String JavaDoc name = null;
48
49     /**
50      * Returns EVAL_BODY_TAG so the body of the tag can be evaluated.
51      *
52      * @return EVAL_BODY_TAG
53      */
54     public final int doStartTag() throws JspException
55     {
56     return EVAL_BODY_TAG;
57     }
58
59     /**
60      * Read the body of the setattribute tag to obtain the attribute value,
61      * then set the attribute with <b>name</b> to that value.
62      *
63      * @return SKIP_BODY
64      */
65     public final int doAfterBody() throws JspException
66     {
67     // Use the body of the tag as attribute value
68 BodyContent body = getBodyContent();
69     String JavaDoc s = body.getString();
70     // Clear the body since we only used it as input for the attribute
71 // value
72 body.clearBody();
73     // set the attribute
74 pageContext.getRequest().setAttribute(name,(Object JavaDoc)s);
75     return SKIP_BODY;
76     }
77
78     /**
79      * Set the required tag attribute <b>name</b>.
80      *
81      * @param String name of request attribute to set value for
82      */
83     public final void setName(String JavaDoc str)
84     {
85     name = str;
86     }
87
88 }
89
Popular Tags