KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > meta > info > writer > XMLServiceWriter


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6
7  Copyright (C) 2002-2003 The Apache Software Foundation. All rights reserved.
8
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24
25  4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
26     "Apache Software Foundation" must not be used to endorse or promote
27     products derived from this software without prior written
28     permission. For written permission, please contact apache@apache.org.
29
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48 */

49
50 package org.apache.avalon.meta.info.writer;
51
52 import java.io.IOException JavaDoc;
53 import java.io.OutputStream JavaDoc;
54 import java.io.OutputStreamWriter JavaDoc;
55 import java.io.Writer JavaDoc;
56
57 import org.apache.avalon.meta.info.Descriptor;
58 import org.apache.avalon.meta.info.Service;
59
60 /**
61  * Write {@link Service} objects to a stream as xml documents.
62  *
63  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
64  * @version $Revision: 1.1.1.1 $ $Date: 2003/07/10 12:10:18 $
65  */

66 public class XMLServiceWriter
67     implements ServiceWriter
68 {
69
70     /**
71      * Write out type representation to xml.
72      *
73      * @param service the service descriptor instance
74      * @param stream the stream to write to
75      * @throws Exception if unable to write xml
76      */

77     public void writeService( final Service service, final OutputStream JavaDoc stream )
78         throws Exception JavaDoc
79     {
80         final Writer JavaDoc writer = new OutputStreamWriter JavaDoc( stream );
81         writeHeader( writer );
82         writeDoctype( writer, "service" );
83         writer.write( "\n\n<service>" );
84
85         writer.write( "\n <version>");
86         writer.write( service.getVersion().toString() );
87         writer.write( "</version>");
88
89         writeAttributes( writer, service );
90         writer.write( "\n</service>" );
91         writer.flush();
92     }
93
94    /**
95     * Write the XML header.
96     * @param writer the writer
97      * @throws IOException if unable to write xml
98     */

99     private void writeHeader( final Writer JavaDoc writer )
100         throws IOException JavaDoc
101     {
102         writer.write( "<?xml version=\"1.0\" ?>" );
103     }
104
105     /**
106      * Write out DOCType delcaration.
107      *
108      * @param writer the writer
109      * @param root the root name of document
110      * @throws IOException if unable to write xml
111      */

112     private void writeDoctype( final Writer JavaDoc writer,
113                                final String JavaDoc root )
114         throws IOException JavaDoc
115     {
116         final String JavaDoc doctype =
117             "\n<!DOCTYPE " + root
118             + " PUBLIC \"-//AVALON/Service DTD Version 1.0//EN\" "
119             + "\"http://avalon.apache.org/dtds/meta/service_1_0.dtd\" >";
120         writer.write( doctype );
121     }
122
123     /**
124      * Write out xml representation of a set of attributes.
125      *
126      * @param writer the writer
127      * @param descriptor a meta info descriptor holding attributes
128      * @throws IOException if unable to write xml
129      */

130     private void writeAttributes( final Writer JavaDoc writer, final Descriptor descriptor )
131         throws IOException JavaDoc
132     {
133         String JavaDoc[] names = descriptor.getAttributeNames();
134         if( names.length > 0 )
135         {
136             writer.write( "\n <attributes>" );
137             for( int i = 0; i < names.length; i++ )
138             {
139                 writeAttribute( writer, names[i], descriptor.getAttribute( names[i] ) );
140             }
141             writer.write( "\n </attributes>" );
142         }
143     }
144
145     /**
146      * Write out xml representation of a single attribute entry.
147      *
148      * @param writer the writer
149      * @param key the attribute key
150      * @param value the attribute value
151      * @throws IOException if unable to write xml
152      */

153     private void writeAttribute( final Writer JavaDoc writer,
154                                  final String JavaDoc key, final String JavaDoc value )
155         throws IOException JavaDoc
156     {
157         writer.write( "\n <attribute key=\"" );
158         writer.write( key );
159         writer.write( "\" value=\"" );
160         writer.write( value );
161         writer.write( "\"/>" );
162     }
163 }
164
Popular Tags