1 /*
2 * Copyright (c) 2003, Henri Yandell
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or
6 * without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * + Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * + Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * + Neither the name of XmlWriter nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32 package com.generationjava.io.xml;
33
34 import java.io.IOException;
35
36 /***
37 * Provides a few method implementations for XmlWriter implementations.
38 * The method implementations all depend on other methods which must
39 * be implemented.
40 */
41 public abstract class AbstractXmlWriter implements XmlWriter {
42
43 /***
44 * Makes it easy to output the xml version if such a thing is desired.
45 * While it usually is desired, it is less surprising not to handle it.
46 */
47 public XmlWriter writeXmlVersion() throws IOException {
48 return this.writeXmlVersion("1.0", null, null);
49 }
50 /*** @see XmlWriter.writeXmlVersion(String, String, String) */
51 public XmlWriter writeXmlVersion(String version, String encoding) throws IOException {
52 return this.writeXmlVersion(version, encoding, null);
53 }
54
55 /***
56 * A helper method. It writes out an entity which contains only text.
57 *
58 * @param name String name of tag
59 * @param text String of text to go inside the tag
60 */
61 public XmlWriter writeEntityWithText(String name, Object text) throws IOException {
62 writeEntity(name);
63 writeText(text);
64 return endEntity();
65 }
66
67 /***
68 * A helper method. It writes out empty entities.
69 *
70 * @param name String name of tag
71 */
72 public XmlWriter writeEmptyEntity(String name) throws IOException {
73 writeEntity(name);
74 return endEntity();
75 }
76
77 }