Java > Open Source Codes > org > apache > xml > serializer > EmptySerializer


1 /*
2  * Copyright 2003-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 /*
17  * $Id: EmptySerializer.java,v 1.5 2004/02/17 04:18:19 minchau Exp $
18  */
19 package org.apache.xml.serializer;
20
21 import java.io.IOException ;
22 import java.io.OutputStream ;
23 import java.io.Writer ;
24 import java.util.Hashtable ;
25 import java.util.Properties ;
26 import java.util.Vector ;
27
28 import javax.xml.transform.SourceLocator ;
29 import javax.xml.transform.Transformer ;
30
31 import org.w3c.dom.Node ;
32 import org.xml.sax.Attributes ;
33 import org.xml.sax.ContentHandler ;
34 import org.xml.sax.Locator ;
35 import org.xml.sax.SAXException ;
36 import org.xml.sax.SAXParseException ;
37
38 /**
39  * This class is an adapter class. Its only purpose is to be extended and
40  * for that extended class to over-ride all methods that are to be used.
41  */
42 public class EmptySerializer implements SerializationHandler
43 {
44     protected static final String ERR = "EmptySerializer method not over-ridden";
45     /**
46      * @see org.apache.xml.serializer.SerializationHandler#asContentHandler()
47      */
48
49     private static void throwUnimplementedException()
50     {
51         /* TODO: throw this exception for real.
52          * Some users of this class do not over-ride all methods that
53          * they use, which is a violation of the intended use of this
54          * class. Those tests used to end in error, but fail when this
55          * exception is enabled. Perhaps that is an indication of what
56          * the true problem is. Such tests include copy56,58,59,60 for
57          * both Xalan-J interpretive and for XSLTC. - bjm
58          */
59         // throw new RuntimeException(err);
60 return;
61     }
62     /**
63      * @see org.apache.xml.serializer.SerializationHandler#asContentHandler()
64      */
65     public ContentHandler asContentHandler() throws IOException
66     {
67         throwUnimplementedException();
68         return null;
69     }
70     /**
71      * @see org.apache.xml.serializer.SerializationHandler#setContentHandler(org.xml.sax.ContentHandler)
72      */
73     public void setContentHandler(ContentHandler ch)
74     {
75         throwUnimplementedException();
76     }
77     /**
78      * @see org.apache.xml.serializer.SerializationHandler#close()
79      */
80     public void close()
81     {
82         throwUnimplementedException();
83     }
84     /**
85      * @see org.apache.xml.serializer.SerializationHandler#getOutputFormat()
86      */
87     public Properties getOutputFormat()
88     {
89         throwUnimplementedException();
90         return null;
91     }
92     /**
93      * @see org.apache.xml.serializer.SerializationHandler#getOutputStream()
94      */
95     public OutputStream getOutputStream()
96     {
97         throwUnimplementedException();
98         return null;
99     }
100     /**
101      * @see org.apache.xml.serializer.SerializationHandler#getWriter()
102      */
103     public Writer getWriter()
104     {
105         throwUnimplementedException();
106         return null;
107     }
108     /**
109      * @see org.apache.xml.serializer.SerializationHandler#reset()
110      */
111     public boolean reset()
112     {
113         throwUnimplementedException();
114         return false;
115     }
116     /**
117      * @see org.apache.xml.serializer.SerializationHandler#serialize(org.w3c.dom.Node)
118      */
119     public void serialize(Node node) throws IOException
120     {
121         throwUnimplementedException();
122     }
123     /**
124      * @see org.apache.xml.serializer.SerializationHandler#setCdataSectionElements(java.util.Vector)
125      */
126     public void setCdataSectionElements(Vector URI_and_localNames)
127     {
128         throwUnimplementedException();
129     }
130     /**
131      * @see org.apache.xml.serializer.SerializationHandler#setEscaping(boolean)
132      */
133     public boolean setEscaping(boolean escape) throws SAXException
134     {
135         throwUnimplementedException();
136         return false;
137     }
138     /**
139      * @see org.apache.xml.serializer.SerializationHandler#setIndent(boolean)
140      */
141     public void setIndent(boolean indent)
142     {
143         throwUnimplementedException();
144     }
145     /**
146      * @see org.apache.xml.serializer.SerializationHandler#setIndentAmount(int)
147      */
148     public void setIndentAmount(int spaces)
149     {
150         throwUnimplementedException();
151     }
152     /**
153      * @see org.apache.xml.serializer.SerializationHandler#setOutputFormat(java.util.Properties)
154      */
155     public void setOutputFormat(Properties format)
156     {
157         throwUnimplementedException();
158     }
159     /**
160      * @see org.apache.xml.serializer.SerializationHandler#setOutputStream(java.io.OutputStream)
161      */
162     public void setOutputStream(OutputStream output)
163     {
164         throwUnimplementedException();
165     }
166     /**
167      * @see org.apache.xml.serializer.SerializationHandler#setVersion(java.lang.String)
168      */
169     public void setVersion(String version)
170     {
171         throwUnimplementedException();
172     }
173     /**
174      * @see org.apache.xml.serializer.SerializationHandler#setWriter(java.io.Writer)
175      */
176     public void setWriter(Writer writer)
177     {
178         throwUnimplementedException();
179     }
180     /**
181      * @see org.apache.xml.serializer.SerializationHandler#setTransformer(javax.xml.transform.Transformer)
182      */
183     public void setTransformer(Transformer transformer)
184     {
185         throwUnimplementedException();
186     }
187     /**
188      * @see org.apache.xml.serializer.SerializationHandler#getTransformer()
189      */
190     public Transformer getTransformer()
191     {
192         throwUnimplementedException();
193         return null;
194     }
195     /**
196      * @see org.apache.xml.serializer.SerializationHandler#flushPending()
197      */
198     public void flushPending() throws SAXException
199     {
200         throwUnimplementedException();
201     }
202     /**
203      * @see org.apache.xml.serializer.ExtendedContentHandler#addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
204      */
205     public void addAttribute(
206         String uri,
207         String localName,
208         String rawName,
209         String type,
210         String value)
211         throws SAXException
212     {
213         throwUnimplementedException();
214     }
215     /**
216      * @see org.apache.xml.serializer.ExtendedContentHandler#addAttributes(org.xml.sax.Attributes)
217      */
218     public void addAttributes(Attributes atts) throws SAXException
219     {
220         throwUnimplementedException();
221     }
222     /**
223      * @see org.apache.xml.serializer.ExtendedContentHandler#addAttribute(java.lang.String, java.lang.String)
224      */
225     public void addAttribute(String name, String value)
226     {
227         throwUnimplementedException();
228     }
229
230     /**
231      * @see org.apache.xml.serializer.ExtendedContentHandler#characters(java.lang.String)
232      */
233     public void characters(String chars) throws SAXException
234     {
235         throwUnimplementedException();
236     }
237     /**
238      * @see org.apache.xml.serializer.ExtendedContentHandler#endElement(java.lang.String)
239      */
240     public void endElement(String elemName) throws SAXException
241     {
242         throwUnimplementedException();
243     }
244     /**
245      * @see org.apache.xml.serializer.ExtendedContentHandler#startDocument()
246      */
247     public void startDocument() throws SAXException
248     {
249         throwUnimplementedException();
250     }
251     /**
252      * @see org.apache.xml.serializer.ExtendedContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String)
253      */
254     public void startElement(String uri, String localName, String qName)
255         throws SAXException
256     {
257         throwUnimplementedException();
258     }
259     /**
260      * @see org.apache.xml.serializer.ExtendedContentHandler#startElement(java.lang.String)
261      */
262     public void startElement(String qName) throws SAXException
263     {
264         throwUnimplementedException();
265     }
266     /**
267      * @see org.apache.xml.serializer.ExtendedContentHandler#namespaceAfterStartElement(java.lang.String, java.lang.String)
268      */
269     public void namespaceAfterStartElement(String uri, String prefix)
270         throws SAXException
271     {
272         throwUnimplementedException();
273     }
274     /**
275      * @see org.apache.xml.serializer.ExtendedContentHandler#startPrefixMapping(java.lang.String, java.lang.String, boolean)
276      */
277     public boolean startPrefixMapping(
278         String prefix,
279         String uri,
280         boolean shouldFlush)
281         throws SAXException
282     {
283         throwUnimplementedException();
284         return false;
285     }
286     /**
287      * @see org.apache.xml.serializer.ExtendedContentHandler#entityReference(java.lang.String)
288      */
289     public void entityReference(String entityName) throws SAXException
290     {
291         throwUnimplementedException();
292     }
293     /**
294      * @see org.apache.xml.serializer.ExtendedContentHandler#getNamespaceMappings()
295      */
296     public NamespaceMappings getNamespaceMappings()
297     {
298         throwUnimplementedException();
299         return null;
300     }
301     /**
302      * @see org.apache.xml.serializer.ExtendedContentHandler#getPrefix(java.lang.String)
303      */
304     public String getPrefix(String uri)
305     {
306         throwUnimplementedException();
307         return null;
308     }
309     /**
310      * @see org.apache.xml.serializer.ExtendedContentHandler#getNamespaceURI(java.lang.String, boolean)
311      */
312     public String getNamespaceURI(String name, boolean isElement)
313     {
314         throwUnimplementedException();
315         return null;
316     }
317     /**
318      * @see org.apache.xml.serializer.ExtendedContentHandler#getNamespaceURIFromPrefix(java.lang.String)
319      */
320     public String getNamespaceURIFromPrefix(String prefix)
321     {
322         throwUnimplementedException();
323         return null;
324     }
325     /**
326      * @see org.xml.sax.ContentHandler#setDocumentLocator(org.xml.sax.Locator)
327      */
328     public void setDocumentLocator(Locator arg0)
329     {
330         throwUnimplementedException();
331     }
332     /**
333      * @see org.xml.sax.ContentHandler#endDocument()
334      */
335     public void endDocument() throws SAXException
336     {
337         throwUnimplementedException();
338     }
339     /**
340      * @see org.xml.sax.ContentHandler#startPrefixMapping(java.lang.String, java.lang.String)
341      */
342     public void startPrefixMapping(String arg0, String arg1)
343         throws SAXException
344     {
345         throwUnimplementedException();
346     }
347     /**
348      * @see org.xml.sax.ContentHandler#endPrefixMapping(java.lang.String)
349      */
350     public void endPrefixMapping(String arg0) throws SAXException
351     {
352         throwUnimplementedException();
353     }
354     /**
355      * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
356      */
357     public void startElement(
358         String arg0,
359         String arg1,
360         String arg2,
361         Attributes arg3)
362         throws SAXException
363     {
364         throwUnimplementedException();
365     }
366     /**
367      * @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
368      */
369     public void endElement(String arg0, String arg1, String arg2)
370         throws SAXException
371     {
372         throwUnimplementedException();
373     }
374     /**
375      * @see org.xml.sax.ContentHandler#characters(char[], int, int)
376      */
377     public void characters(char[] arg0, int arg1, int arg2) throws SAXException
378     {
379         throwUnimplementedException();
380     }
381     /**
382      * @see org.xml.sax.ContentHandler#ignorableWhitespace(char[], int, int)
383      */
384     public void ignorableWhitespace(char[] arg0, int arg1, int arg2)
385         throws SAXException
386     {
387         throwUnimplementedException();
388     }
389     /**
390      * @see org.xml.sax.ContentHandler#processingInstruction(java.lang.String, java.lang.String)
391      */
392     public void processingInstruction(String arg0, String arg1)
393         throws SAXException
394     {
395         throwUnimplementedException();
396     }
397     /**
398      * @see org.xml.sax.ContentHandler#skippedEntity(java.lang.String)
399      */
400     public void skippedEntity(String arg0) throws SAXException
401     {
402         throwUnimplementedException();
403     }
404     /**
405      * @see org.apache.xml.serializer.ExtendedLexicalHandler#comment(java.lang.String)
406      */
407     public void comment(String comment) throws SAXException
408     {
409         throwUnimplementedException();
410     }
411     /**
412      * @see org.xml.sax.ext.LexicalHandler#startDTD(java.lang.String, java.lang.String, java.lang.String)
413      */
414     public void startDTD(String arg0, String arg1, String arg2)
415         throws SAXException
416     {
417         throwUnimplementedException();
418     }
419     /**
420      * @see org.xml.sax.ext.LexicalHandler#endDTD()
421      */
422     public void endDTD() throws SAXException
423     {
424         throwUnimplementedException();
425     }
426     /**
427      * @see org.xml.sax.ext.LexicalHandler#startEntity(java.lang.String)
428      */
429     public void startEntity(String arg0) throws SAXException
430     {
431         throwUnimplementedException();
432     }
433     /**
434      * @see org.xml.sax.ext.LexicalHandler#endEntity(java.lang.String)
435      */
436     public void endEntity(String arg0) throws SAXException
437     {
438         throwUnimplementedException();
439     }
440     /**
441      * @see org.xml.sax.ext.LexicalHandler#startCDATA()
442      */
443     public void startCDATA() throws SAXException
444     {
445         throwUnimplementedException();
446     }
447     /**
448      * @see org.xml.sax.ext.LexicalHandler#endCDATA()
449      */
450     public void endCDATA() throws SAXException
451     {
452         throwUnimplementedException();
453     }
454     /**
455      * @see org.xml.sax.ext.LexicalHandler#comment(char[], int, int)
456      */
457     public void comment(char[] arg0, int arg1, int arg2) throws SAXException
458     {
459         throwUnimplementedException();
460     }
461     /**
462      * @see org.apache.xml.serializer.XSLOutputAttributes#getDoctypePublic()
463      */
464     public String getDoctypePublic()
465     {
466         throwUnimplementedException();
467         return null;
468     }
469     /**
470      * @see org.apache.xml.serializer.XSLOutputAttributes#getDoctypeSystem()
471      */
472     public String getDoctypeSystem()
473     {
474         throwUnimplementedException();
475         return null;
476     }
477     /**
478      * @see org.apache.xml.serializer.XSLOutputAttributes#getEncoding()
479      */
480     public String getEncoding()
481     {
482         throwUnimplementedException();
483         return null;
484     }
485     /**
486      * @see org.apache.xml.serializer.XSLOutputAttributes#getIndent()
487      */
488     public boolean getIndent()
489     {
490         throwUnimplementedException();
491         return false;
492     }
493     /**
494      * @see org.apache.xml.serializer.XSLOutputAttributes#getIndentAmount()
495      */
496     public int getIndentAmount()
497     {
498         throwUnimplementedException();
499         return 0;
500     }
501     /**
502      * @see org.apache.xml.serializer.XSLOutputAttributes#getMediaType()
503      */
504     public String getMediaType()
505     {
506         throwUnimplementedException();
507         return null;
508     }
509     /**
510      * @see org.apache.xml.serializer.XSLOutputAttributes#getOmitXMLDeclaration()
511      */
512     public boolean getOmitXMLDeclaration()
513     {
514         throwUnimplementedException();
515         return false;
516     }
517     /**
518      * @see org.apache.xml.serializer.XSLOutputAttributes#getStandalone()
519      */
520     public String getStandalone()
521     {
522         throwUnimplementedException();
523         return null;
524     }
525     /**
526      * @see org.apache.xml.serializer.XSLOutputAttributes#getVersion()
527      */
528     public String getVersion()
529     {
530         throwUnimplementedException();
531         return null;
532     }
533     /**
534      * @see org.apache.xml.serializer.XSLOutputAttributes#setCdataSectionElements
535      */
536     public void setCdataSectionElements(Hashtable h) throws Exception
537     {
538         throwUnimplementedException();
539     }
540     /**
541      * @see org.apache.xml.serializer.XSLOutputAttributes#setDoctype(java.lang.String, java.lang.String)
542      */
543     public void setDoctype(String system, String pub)
544     {
545         throwUnimplementedException();
546     }
547     /**
548      * @see org.apache.xml.serializer.XSLOutputAttributes#setDoctypePublic(java.lang.String)
549      */
550     public void setDoctypePublic(String doctype)
551     {
552         throwUnimplementedException();
553     }
554     /**
555      * @see org.apache.xml.serializer.XSLOutputAttributes#setDoctypeSystem(java.lang.String)
556      */
557     public void setDoctypeSystem(String doctype)
558     {
559         throwUnimplementedException();
560     }
561     /**
562      * @see org.apache.xml.serializer.XSLOutputAttributes#setEncoding(java.lang.String)
563      */
564     public void setEncoding(String encoding)
565     {
566         throwUnimplementedException();
567     }
568     /**
569      * @see org.apache.xml.serializer.XSLOutputAttributes#setMediaType(java.lang.String)
570      */
571     public void setMediaType(String mediatype)
572     {
573         throwUnimplementedException();
574     }
575     /**
576      * @see org.apache.xml.serializer.XSLOutputAttributes#setOmitXMLDeclaration(boolean)
577      */
578     public void setOmitXMLDeclaration(boolean b)
579     {
580         throwUnimplementedException();
581     }
582     /**
583      * @see org.apache.xml.serializer.XSLOutputAttributes#setStandalone(java.lang.String)
584      */
585     public void setStandalone(String standalone)
586     {
587         throwUnimplementedException();
588     }
589     /**
590      * @see org.xml.sax.ext.DeclHandler#elementDecl(java.lang.String, java.lang.String)
591      */
592     public void elementDecl(String arg0, String arg1) throws SAXException
593     {
594         throwUnimplementedException();
595     }
596     /**
597      * @see org.xml.sax.ext.DeclHandler#attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
598      */
599     public void attributeDecl(
600         String arg0,
601         String arg1,
602         String arg2,
603         String arg3,
604         String arg4)
605         throws SAXException
606     {
607         throwUnimplementedException();
608     }
609     /**
610      * @see org.xml.sax.ext.DeclHandler#internalEntityDecl(java.lang.String, java.lang.String)
611      */
612     public void internalEntityDecl(String arg0, String arg1)
613         throws SAXException
614     {
615         throwUnimplementedException();
616     }
617     /**
618      * @see org.xml.sax.ext.DeclHandler#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
619      */
620     public void externalEntityDecl(String arg0, String arg1, String arg2)
621         throws SAXException
622     {
623         throwUnimplementedException();
624     }
625     /**
626      * @see org.xml.sax.ErrorHandler#warning(org.xml.sax.SAXParseException)
627      */
628     public void warning(SAXParseException arg0) throws SAXException
629     {
630         throwUnimplementedException();
631     }
632     /**
633      * @see org.xml.sax.ErrorHandler#error(org.xml.sax.SAXParseException)
634      */
635     public void error(SAXParseException arg0) throws SAXException
636     {
637         throwUnimplementedException();
638     }
639     /**
640      * @see org.xml.sax.ErrorHandler#fatalError(org.xml.sax.SAXParseException)
641      */
642     public void fatalError(SAXParseException arg0) throws SAXException
643     {
644         throwUnimplementedException();
645     }
646     /**
647      * @see org.apache.xml.serializer.Serializer#asDOMSerializer()
648      */
649     public DOMSerializer asDOMSerializer() throws IOException
650     {
651         throwUnimplementedException();
652         return null;
653     }
654
655     /**
656      * @see org.apache.xml.serializer.SerializationHandler#setNamespaceMappings(NamespaceMappings)
657      */
658     public void setNamespaceMappings(NamespaceMappings mappings) {
659         throwUnimplementedException();
660     }
661     
662     /**
663      * @see org.apache.xml.serializer.ExtendedContentHandler#setSourceLocator(javax.xml.transform.SourceLocator)
664      */
665     public void setSourceLocator(SourceLocator locator)
666     {
667         throwUnimplementedException();
668     }
669
670     /**
671      * @see org.apache.xml.serializer.ExtendedContentHandler#addUniqueAttribute(java.lang.String, java.lang.String, int)
672      */
673     public void addUniqueAttribute(String name, String value, int flags)
674         throws SAXException
675     {
676         throwUnimplementedException();
677     }
678 }
679

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags