View Javadoc

1   /* ***** BEGIN LICENSE BLOCK *****
2    * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3    *
4    * The contents of this file are subject to the Mozilla Public License Version
5    * 1.1 (the "License"); you may not use this file except in compliance with
6    * the License. You may obtain a copy of the License at
7    * http://www.mozilla.org/MPL/
8    *
9    * Software distributed under the License is distributed on an "AS IS" basis,
10   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11   * for the specific language governing rights and limitations under the
12   * License.
13   *
14   * The Original Code is "SMS Library for the Java platform".
15   *
16   * The Initial Developer of the Original Code is Markus Eriksson.
17   * Portions created by the Initial Developer are Copyright (C) 2002
18   * the Initial Developer. All Rights Reserved.
19   *
20   * Contributor(s):
21   *
22   * Alternatively, the contents of this file may be used under the terms of
23   * either the GNU General Public License Version 2 or later (the "GPL"), or
24   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
25   * in which case the provisions of the GPL or the LGPL are applicable instead
26   * of those above. If you wish to allow use of your version of this file only
27   * under the terms of either the GPL or the LGPL, and not to allow others to
28   * use your version of this file under the terms of the MPL, indicate your
29   * decision by deleting the provisions above and replace them with the notice
30   * and other provisions required by the GPL or the LGPL. If you do not delete
31   * the provisions above, a recipient may use your version of this file under
32   * the terms of any one of the MPL, the GPL or the LGPL.
33   *
34   * ***** END LICENSE BLOCK ***** */
35  package org.marre.xml;
36  
37  import java.io.IOException;
38  
39  /***
40   * Interface for objects that can be represented in xml form.
41   * 
42   * @author Markus
43   * @version $Id: XmlDocument.java,v 1.2 2004/12/07 20:03:21 c95men Exp $
44   */
45  public interface XmlDocument
46  {
47      /***
48       * Returns the content-type of this xml document.
49       * 
50       * @return Content-type. Ex: "text/xml".
51       */
52      String getContentType();
53      
54      /***
55       * Writes this object to the given XmlWriter.
56       * 
57       * @param xmlWriter XmlWriter to write to.
58       * @throws IOException Thrown if failed to write to xmlwriter.
59       */
60      void writeXmlTo(XmlWriter xmlWriter) throws IOException;
61  }