View Javadoc

1   /*
2   Wotonomy: OpenStep design patterns for pure Java applications.
3   Copyright (C) 2000 Intersect Software Corporation
4   
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9   
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  Lesser General Public License for more details.
14  
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, see http://www.gnu.org
17  */
18  
19  package net.wotonomy.foundation.xml;
20  
21  import java.io.InputStream;
22  import java.net.URL;
23  
24  /***
25  * Defines an interface for classes that can de-serialize 
26  * java objects from an XML representation. 
27  */
28  public interface XMLDecoder
29  {
30      /***
31      * Decodes an object from the specified input stream.
32      * @param anInputStream The input stream from which to read.
33      * The stream will be read fully.
34      * @param aDescription A description to accompany error messages
35      * for the stream, typically a file name.
36      * @param aURL A URL against which relative references within the
37      * XML will be resolved.
38      * @return The object that was constructed from the XML content,
39      * or null if no object could be constructed.
40      */ 
41      public Object decode( 
42          InputStream anInputStream, String aDescription, URL aURL );
43  }
44  
45  /*
46   * $Log$
47   * Revision 1.1  2006/02/18 22:21:10  cgruber
48   * Add in simple xml interfaces from net.wotonomy.xml project.
49   * Add cobertura.ser to .cvsignore.  God I wish sourceforge would move on this subversion thing...
50   *
51   * Revision 1.1  2006/02/16 13:22:22  cgruber
52   * Check in all sources in eclipse-friendly maven-enabled packages.
53   *
54   * Revision 1.2  2001/02/06 14:34:23  mpowers
55   * Forgot to rename the package declarations.
56   *
57   * Revision 1.1  2001/02/06 14:31:19  mpowers
58   * Moving XML utilities from util to xml package.
59   *
60   * Revision 1.1.1.1  2000/12/21 15:52:33  mpowers
61   * Contributing wotonomy.
62   *
63   * Revision 1.2  2000/12/20 16:25:48  michael
64   * Added log to all files.
65   *
66   *
67   */
68