KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jonas_rar > deployment > xml > RequiredConfigProperty


1 /**
2  * JOnAS: Java(TM) Open Application Server
3  * Copyright (C) 1999 Bull S.A.
4  * Contact: jonas-team@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  *
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or 1any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20  * USA
21  *
22  * Initial developer: Eric Hardesty
23  * --------------------------------------------------------------------------
24  * $Id: RequiredConfigProperty.java,v 1.1 2003/11/11 20:03:28 ehardesty Exp $
25  * --------------------------------------------------------------------------
26  */
27 package org.objectweb.jonas_rar.deployment.xml;
28
29 import org.objectweb.jonas_lib.deployment.xml.AbsElement;
30 import org.objectweb.jonas_lib.deployment.xml.JLinkedList;
31
32 /**
33  * This class defines the implementation of the element required-config-property
34  *
35  * @author Florent Benoit
36  */
37
38 public class RequiredConfigProperty extends AbsElement {
39
40     /**
41      * description
42      */
43     private JLinkedList descriptionList = null;
44
45     /**
46      * config-property-name
47      */
48     private String JavaDoc configPropertyName = null;
49
50     /**
51      * Constructor
52      */
53     public RequiredConfigProperty() {
54         super();
55         descriptionList = new JLinkedList("description");
56     }
57
58     /**
59      * Gets the description
60      * @return the description
61      */
62     public JLinkedList getDescriptionList() {
63         return descriptionList;
64     }
65
66     /**
67      * Set the description
68      * @param descriptionList description
69      */
70     public void setDescriptionList(JLinkedList descriptionList) {
71         this.descriptionList = descriptionList;
72     }
73
74     /**
75      * Add a new description element to this object
76      * @param description the description String
77      */
78     public void addDescription(String JavaDoc description) {
79         descriptionList.add(description);
80     }
81
82     /**
83      * Gets the config-property-name
84      * @return the config-property-name
85      */
86     public String JavaDoc getConfigPropertyName() {
87         return configPropertyName;
88     }
89
90     /**
91      * Set the config-property-name
92      * @param configPropertyName configPropertyName
93      */
94     public void setConfigPropertyName(String JavaDoc configPropertyName) {
95         this.configPropertyName = configPropertyName;
96     }
97
98     /**
99      * Represents this element by it's XML description.
100      * @param indent use this indent for prefixing XML representation.
101      * @return the XML description of this object.
102      */
103     public String JavaDoc toXML(int indent) {
104         StringBuffer JavaDoc sb = new StringBuffer JavaDoc();
105         sb.append(indent(indent));
106         sb.append("<required-config-property>\n");
107
108         indent += 2;
109
110         // description
111 sb.append(descriptionList.toXML(indent));
112         // config-property-name
113 sb.append(xmlElement(configPropertyName, "config-property-name", indent));
114         indent -= 2;
115         sb.append(indent(indent));
116         sb.append("</required-config-property>\n");
117
118         return sb.toString();
119     }
120 }
121
Popular Tags