001: /*
002: * Copyright 1999,2004 The Apache Software Foundation.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.apache.catalina.util;
018:
019: import java.io.IOException;
020: import java.io.Writer;
021:
022: /**
023: * XMLWriter helper class.
024: *
025: * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
026: */
027: public class XMLWriter {
028:
029: // -------------------------------------------------------------- Constants
030:
031: /**
032: * Opening tag.
033: */
034: public static final int OPENING = 0;
035:
036: /**
037: * Closing tag.
038: */
039: public static final int CLOSING = 1;
040:
041: /**
042: * Element with no content.
043: */
044: public static final int NO_CONTENT = 2;
045:
046: // ----------------------------------------------------- Instance Variables
047:
048: /**
049: * Buffer.
050: */
051: protected StringBuffer buffer = new StringBuffer();
052:
053: /**
054: * Writer.
055: */
056: protected Writer writer = null;
057:
058: // ----------------------------------------------------------- Constructors
059:
060: /**
061: * Constructor.
062: */
063: public XMLWriter() {
064: }
065:
066: /**
067: * Constructor.
068: */
069: public XMLWriter(Writer writer) {
070: this .writer = writer;
071: }
072:
073: // --------------------------------------------------------- Public Methods
074:
075: /**
076: * Retrieve generated XML.
077: *
078: * @return String containing the generated XML
079: */
080: public String toString() {
081: return buffer.toString();
082: }
083:
084: /**
085: * Write property to the XML.
086: *
087: * @param namespace Namespace
088: * @param namespaceInfo Namespace info
089: * @param name Property name
090: * @param value Property value
091: */
092: public void writeProperty(String namespace, String namespaceInfo,
093: String name, String value) {
094: writeElement(namespace, namespaceInfo, name, OPENING);
095: buffer.append(value);
096: writeElement(namespace, namespaceInfo, name, CLOSING);
097:
098: }
099:
100: /**
101: * Write property to the XML.
102: *
103: * @param namespace Namespace
104: * @param name Property name
105: * @param value Property value
106: */
107: public void writeProperty(String namespace, String name,
108: String value) {
109: writeElement(namespace, name, OPENING);
110: buffer.append(value);
111: writeElement(namespace, name, CLOSING);
112: }
113:
114: /**
115: * Write property to the XML.
116: *
117: * @param namespace Namespace
118: * @param name Property name
119: */
120: public void writeProperty(String namespace, String name) {
121: writeElement(namespace, name, NO_CONTENT);
122: }
123:
124: /**
125: * Write an element.
126: *
127: * @param name Element name
128: * @param namespace Namespace abbreviation
129: * @param type Element type
130: */
131: public void writeElement(String namespace, String name, int type) {
132: writeElement(namespace, null, name, type);
133: }
134:
135: /**
136: * Write an element.
137: *
138: * @param namespace Namespace abbreviation
139: * @param namespaceInfo Namespace info
140: * @param name Element name
141: * @param type Element type
142: */
143: public void writeElement(String namespace, String namespaceInfo,
144: String name, int type) {
145: if ((namespace != null) && (namespace.length() > 0)) {
146: switch (type) {
147: case OPENING:
148: if (namespaceInfo != null) {
149: buffer.append("<" + namespace + ":" + name
150: + " xmlns:" + namespace + "=\""
151: + namespaceInfo + "\">");
152: } else {
153: buffer.append("<" + namespace + ":" + name + ">");
154: }
155: break;
156: case CLOSING:
157: buffer.append("</" + namespace + ":" + name + ">\n");
158: break;
159: case NO_CONTENT:
160: default:
161: if (namespaceInfo != null) {
162: buffer.append("<" + namespace + ":" + name
163: + " xmlns:" + namespace + "=\""
164: + namespaceInfo + "\"/>");
165: } else {
166: buffer.append("<" + namespace + ":" + name + "/>");
167: }
168: break;
169: }
170: } else {
171: switch (type) {
172: case OPENING:
173: buffer.append("<" + name + ">");
174: break;
175: case CLOSING:
176: buffer.append("</" + name + ">\n");
177: break;
178: case NO_CONTENT:
179: default:
180: buffer.append("<" + name + "/>");
181: break;
182: }
183: }
184: }
185:
186: /**
187: * Write text.
188: *
189: * @param text Text to append
190: */
191: public void writeText(String text) {
192: buffer.append(text);
193: }
194:
195: /**
196: * Write data.
197: *
198: * @param data Data to append
199: */
200: public void writeData(String data) {
201: buffer.append("<![CDATA[" + data + "]]>");
202: }
203:
204: /**
205: * Write XML Header.
206: */
207: public void writeXMLHeader() {
208: buffer.append("<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n");
209: }
210:
211: /**
212: * Send data and reinitializes buffer.
213: */
214: public void sendData() throws IOException {
215: if (writer != null) {
216: writer.write(buffer.toString());
217: buffer = new StringBuffer();
218: }
219: }
220:
221: }
|