KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > xml > PI


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.xml;
59
60 import org.apache.ecs.ConcreteElement;
61 import org.apache.ecs.Element;
62 import org.apache.ecs.Printable;
63
64 public class PI extends ConcreteElement implements Printable
65 {
66     // Private initializer
67 {
68         setBeginStartModifier('?');
69         setBeginEndModifier('?');
70         setNeedClosingTag(false);
71         setElementType("xml");
72     }
73
74     public PI()
75     {
76     }
77
78     /**
79         Set the version of this document.
80         @param version the version of this document.
81     */
82     public PI setVersion(String JavaDoc version)
83     {
84         addAttribute("version",version);
85         return(this);
86     }
87
88     /**
89         Set the version of this document.
90         @param version the version of this document.
91     */
92     public PI setVersion(float version)
93     {
94         setVersion(Float.toString(version));
95         return(this);
96     }
97
98     /**
99         Set the version of this document.
100         @param version the version of this document.
101     */
102     public PI setVersion(double version)
103     {
104         setVersion(Double.toString(version));
105         return(this);
106     }
107
108     /**
109         Sets the target of this document.
110         It is used to identigy the application
111         to which the instruction is directed.
112         @param target The target application.
113     */
114     public PI setTarget(String JavaDoc target)
115     {
116         setElementType(target);
117         return(this);
118     }
119     
120     /**
121      * Add an additional instruction (which works like an XML
122      * attribute) to the PI
123      *
124      * @param name - Name of instruction (e.g. standalone)
125      * @param value - value of instruction (e.g. "no")
126      */
127     public PI addInstruction(String JavaDoc name, String JavaDoc value) {
128         addAttribute(name, value);
129         return(this);
130     }
131     
132     /**
133         Adds an Element to the element.
134         @param hashcode name of element for hash table
135         @param element Adds an Element to the element.
136      */
137     public PI addElement(String JavaDoc hashcode,Element element)
138     {
139         addElementToRegistry(hashcode,element);
140         return(this);
141     }
142     /**
143         Adds an Element to the element.
144         @param hashcode name of element for hash table
145         @param element Adds an Element to the element.
146      */
147     public PI addElement(String JavaDoc hashcode,String JavaDoc element)
148     {
149         addElementToRegistry(hashcode,element);
150         return(this);
151     }
152     /**
153         Adds an Element to the element.
154         @param element Adds an Element to the element.
155      */
156     public PI addElement(Element element)
157     {
158         addElementToRegistry(element);
159         return(this);
160     }
161     /**
162         Adds an Element to the element.
163         @param element Adds an Element to the element.
164      */
165     public PI addElement(String JavaDoc element)
166     {
167         addElementToRegistry(element);
168         return(this);
169     }
170     /**
171         Removes an Element from the element.
172         @param hashcode the name of the element to be removed.
173     */
174     public PI removeElement(String JavaDoc hashcode)
175     {
176         removeElementFromRegistry(hashcode);
177         return(this);
178     }
179 }
180
Popular Tags