KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sapia > util > xml > idefix > SerializerIF


1 package org.sapia.util.xml.idefix;
2
3 import org.sapia.util.xml.Namespace;
4
5
6 /**
7  *
8  *
9  * @author <a HREF="mailto:jc@sapia-oss.org">Jean-Cedric Desrochers</a>
10  * <dl>
11  * <dt><b>Copyright:</b><dd>Copyright &#169; 2002-2003 <a HREF="http://www.sapia-oss.org">Sapia Open Source Software</a>. All Rights Reserved.</dd></dt>
12  * <dt><b>License:</b><dd>Read the license.txt file of the jar or visit the
13  * <a HREF="http://www.sapia-oss.org/license.html" target="sapia-license">license page</a> at the Sapia OSS web site</dd></dt>
14  * </dl>
15  */

16 public interface SerializerIF {
17   /**
18    * Transforms the object passed in into an XML representation. This method is called when the
19    * object to transform is represents the root element of the XML document to create.
20    *
21    * @param anObject The object to serialize.
22    * @param aContext The serialization context to use.
23    * @exception SerializationException If an error occurs serializing the object.
24    */

25   public void serialize(Object JavaDoc anObject, SerializationContext aContext)
26     throws SerializationException;
27
28   /**
29    * Transforms the object passed in into an XML representation. This method is called when the
30    * object to transform is nested inside another object.
31    *
32    * @param anObject The object to serialize.
33    * @param aNamespace The namespace of the object to serialize.
34    * @param anObjectName The name of the object to serialize.
35    * @param aContext The serialization context to use.
36    * @exception SerializationException If an error occurs serializing the object.
37    */

38   public void serialize(Object JavaDoc anObject, Namespace aNamespace,
39     String JavaDoc anObjectName, SerializationContext aContext)
40     throws SerializationException;
41 }
42
Popular Tags