KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.sapia.util.xml.idefix;
2
3
4 // Import of Sun's JDK classes
5
// ---------------------------
6
import java.util.Collection JavaDoc;
7 import java.util.Iterator JavaDoc;
8 import java.util.List JavaDoc;
9 import java.util.Map JavaDoc;
10
11
12 /**
13  *
14  *
15  * @author Jean-Cedric Desrochers
16  *
17  * <dl>
18  * <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>
19  * <dt><b>License:</b><dd>Read the license.txt file of the jar or visit the
20  * <a HREF="http://www.sapia-oss.org/license.html">license page</a> at the Sapia OSS web site</dd></dt>
21  * </dl>
22  */

23 public class CompleteEncoder implements XmlEncoderIF {
24   /////////////////////////////////////////////////////////////////////////////////////////
25
//////////////////////////////////// CONSTRUCTORS /////////////////////////////////////
26
/////////////////////////////////////////////////////////////////////////////////////////
27

28   /**
29    * Creates a new CompleteEncoder instance.
30    */

31   public CompleteEncoder() {
32   }
33
34   /////////////////////////////////////////////////////////////////////////////////////////
35
/////////////////////////////// INTERACE IMPLEMENTATION ///////////////////////////////
36
/////////////////////////////////////////////////////////////////////////////////////////
37

38   /**
39    * Encodes the object passed in as a leaf.
40    *
41    * @param aName The name of the leaf to encode.
42    * @param aValue The value of the leaf to encode.
43    * @param anXmlBuffer The xml buffer to use to encode the leaf.
44    */

45   public void encodeLeaf(String JavaDoc aName, Object JavaDoc aValue, XmlBuffer anXmlBuffer) {
46   }
47
48   /**
49    * Encodes the object passed in as a node.
50    *
51    * @param anObject The object to encode.
52    * @param anXmlBuffer The xml buffer to use to encode the node.
53    * @param someObjects The list of visited object (to detect circular references).
54    */

55   public void encodeNode(Object JavaDoc anObject, XmlBuffer anXmlBuffer,
56     List JavaDoc someObjects) {
57   }
58
59   /**
60    * Encodes the object passed in as a java array.
61    *
62    * @param anArray The array of objects to encode.
63    * @param anXmlBuffer The xml buffer to use to encode the leaf.
64    * @param someObjects The list of visited object (to detect circular references).
65    */

66   public void encodeArray(Object JavaDoc anArray, XmlBuffer anXmlBuffer,
67     List JavaDoc someObjects) {
68   }
69
70   /**
71    * Encodes the object passed in as a collection.
72    *
73    * @param aCollection The collection of objects to encode.
74    * @param anXmlBuffer The xml buffer to use to encode the object.
75    * @param someObjects The list of visited object (to detect circular references).
76    */

77   public void encodeCollection(Collection JavaDoc aCollection, XmlBuffer anXmlBuffer,
78     List JavaDoc someObjects) {
79   }
80
81   /**
82    * Encodes the object passed in as an iterator.
83    *
84    * @param anIterator The iterator of objects to encode.
85    * @param anXmlBuffer The xml buffer to use to encode the object.
86    * @param someObjects The list of visited object (to detect circular references).
87    */

88   public void encodeIterator(Iterator JavaDoc anIterator, XmlBuffer anXmlBuffer,
89     List JavaDoc someObjects) {
90   }
91
92   /**
93    * Encodes the object passed in as a map.
94    *
95    * @param aMap The map of objects to encode.
96    * @param anXmlBuffer The xml buffer to use to encode the object.
97    * @param someObjects The list of visited object (to detect circular references).
98    */

99   public void encodeMap(Map JavaDoc aMap, XmlBuffer anXmlBuffer, List JavaDoc someObjects) {
100   }
101 }
102
Popular Tags