KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > html > Param


1 /*
2  * ====================================================================
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2003 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, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Jakarta Element Construction Set",
29  * "Jakarta ECS" , and "Apache Software Foundation" must not be used
30  * to endorse or promote products derived
31  * from this software without prior written permission. For written
32  * permission, please contact apache@apache.org.
33  *
34  * 5. Products derived from this software may not be called "Apache",
35  * "Jakarta Element Construction Set" nor "Jakarta ECS" nor may "Apache"
36  * appear in their names without prior written permission of the Apache Group.
37  *
38  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
39  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
40  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
41  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
44  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
46  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49  * SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This software consists of voluntary contributions made by many
53  * individuals on behalf of the Apache Software Foundation. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  *
57  */
58 package org.apache.ecs.html;
59
60 import org.apache.ecs.*;
61
62 /**
63     This class creates an Param Element
64
65     @version $Id: Param.java,v 1.3 2003/04/27 09:22:49 rdonkin Exp $
66     @author <a HREF="mailto:snagy@servletapi.com">Stephan Nagy</a>
67     @author <a HREF="mailto:jon@clearink.com">Jon S. Stevens</a>
68 */
69 public class Param extends SinglePartElement implements Printable
70 {
71     // Convience variables.
72
73     public final static String JavaDoc REF = "ref";
74     public final static String JavaDoc DATA = "data";
75     public final static String JavaDoc OBJECT = "object";
76     public final static String JavaDoc ref = "ref";
77     public final static String JavaDoc data = "data";
78     public final static String JavaDoc object = "object";
79
80     /**
81         private initializer.
82     */
83     {
84         setElementType("param");
85     }
86
87     /**
88         Default constructor. use set* methods.
89     */
90     public Param()
91     {
92     }
93
94     /**
95         Sets the name of this parameter.
96         @param name sets the name of this parameter.
97     */
98     public Param setName(String JavaDoc name)
99     {
100         addAttribute("name",name);
101         return(this);
102     }
103
104     /**
105         Sets the value of this attribute.
106         @param value sets the value attribute.
107     */
108     public Param setValue(String JavaDoc value)
109     {
110         addAttribute("value",value);
111         return(this);
112     }
113
114     /**
115         Sets the valuetype of this parameter.
116         @param valuetype sets the name of this parameter.<br>
117         REF|DATA|OBJECT convience varaibles provided as Param.REF,Param.DATA,Param.OBJECT
118     */
119     public Param setValueType(String JavaDoc valuetype)
120     {
121         addAttribute("value",valuetype);
122         return(this);
123     }
124
125     /**
126         Sets the mime type of this object
127         @param the mime type of this object
128     */
129     public Param setType(String JavaDoc cdata)
130     {
131         addAttribute("type",cdata);
132         return(this);
133     }
134
135     /**
136         Adds an Element to the element.
137         @param hashcode name of element for hash table
138         @param element Adds an Element to the element.
139      */
140     public Param addElement(String JavaDoc hashcode,Element element)
141     {
142         addElementToRegistry(hashcode,element);
143         return(this);
144     }
145
146     /**
147         Adds an Element to the element.
148         @param hashcode name of element for hash table
149         @param element Adds an Element to the element.
150      */
151     public Param addElement(String JavaDoc hashcode,String JavaDoc element)
152     {
153         addElementToRegistry(hashcode,element);
154         return(this);
155     }
156
157     /**
158         Adds an Element to the element.
159         @param element Adds an Element to the element.
160      */
161     public Param addElement(Element element)
162     {
163         addElementToRegistry(element);
164         return(this);
165     }
166
167     /**
168         Adds an Element to the element.
169         @param element Adds an Element to the element.
170      */
171     public Param addElement(String JavaDoc element)
172     {
173         addElementToRegistry(element);
174         return(this);
175     }
176     /**
177         Removes an Element from the element.
178         @param hashcode the name of the element to be removed.
179     */
180     public Param removeElement(String JavaDoc hashcode)
181     {
182         removeElementFromRegistry(hashcode);
183         return(this);
184     }
185 }
186
Popular Tags