| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:37 PDT 2012 --> | |
| <TITLE> | |
| WriterChain | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xml.serializer.WriterChain interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="WriterChain"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WriterChain.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xml/serializer/Version.html" title="class in org.apache.xml.serializer"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xml/serializer/WriterToASCI.html" title="class in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xml/serializer/WriterChain.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="WriterChain.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.xml.serializer</FONT> | |
| <BR> | |
| Interface WriterChain</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xml/serializer/SerializerTraceWriter.html" title="class in org.apache.xml.serializer">SerializerTraceWriter</A>, <A HREF="../../../../org/apache/xml/serializer/WriterToASCI.html" title="class in org.apache.xml.serializer">WriterToASCI</A>, <A HREF="../../../../org/apache/xml/serializer/WriterToUTF8Buffered.html" title="class in org.apache.xml.serializer">WriterToUTF8Buffered</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>interface <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.51"><B>WriterChain</B></A></DL> | |
| </PRE> | |
| <P> | |
| It is unfortunate that java.io.Writer is a class rather than an interface. | |
| The serializer has a number of classes that extend java.io.Writer | |
| and which send their ouput to a yet another wrapped Writer or OutputStream. | |
| The purpose of this interface is to force such classes to over-ride all of | |
| the important methods defined on the java.io.Writer class, namely these: | |
| <code> | |
| write(int val) | |
| write(char[] chars) | |
| write(char[] chars, int start, int count) | |
| write(String chars) | |
| write(String chars, int start, int count) | |
| flush() | |
| close() | |
| </code> | |
| In this manner nothing will accidentally go directly to | |
| the base class rather than to the wrapped Writer or OutputStream. | |
| The purpose of this class is to have a uniform way of chaining the output of one writer to | |
| the next writer in the chain. In addition there are methods to obtain the Writer or | |
| OutputStream that this object sends its output to. | |
| This interface is only for internal use withing the serializer. | |
| <P> | |
| <P> | |
| <HR> | |
| <P> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#close()">close</A></B>()</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#flush()">flush</A></B>()</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.io.OutputStream</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#getOutputStream()">getOutputStream</A></B>()</CODE> | |
| <BR> | |
| If this method returns null, getWriter() must return non-null.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.io.Writer</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#getWriter()">getWriter</A></B>()</CODE> | |
| <BR> | |
| If this method returns null, getOutputStream() must return non-null.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#write(char[])">write</A></B>(char[] chars)</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#write(char[], int, int)">write</A></B>(char[] chars, | |
| int start, | |
| int count)</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#write(int)">write</A></B>(int val)</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#write(java.lang.String)">write</A></B>(java.lang.String chars)</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/WriterChain.html#write(java.lang.String, int, int)">write</A></B>(java.lang.String chars, | |
| int start, | |
| int count)</CODE> | |
| <BR> | |
| This method forces us to over-ride the method defined in java.io.Writer</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="write(int)"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.54"><B>write</B></A>(int val) | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="write(char[])"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.56"><B>write</B></A>(char[] chars) | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="write(char[], int, int)"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.58"><B>write</B></A>(char[] chars, | |
| int start, | |
| int count) | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="write(java.lang.String)"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.60"><B>write</B></A>(java.lang.String chars) | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="write(java.lang.String, int, int)"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.62"><B>write</B></A>(java.lang.String chars, | |
| int start, | |
| int count) | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="flush()"><!-- --></A><H3> | |
| flush</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.64"><B>flush</B></A>() | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="close()"><!-- --></A><H3> | |
| close</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.66"><B>close</B></A>() | |
| throws java.io.IOException</PRE> | |
| <DL> | |
| <DD>This method forces us to over-ride the method defined in java.io.Writer | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.io.IOException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getWriter()"><!-- --></A><H3> | |
| getWriter</H3> | |
| <PRE> | |
| java.io.Writer <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.75"><B>getWriter</B></A>()</PRE> | |
| <DL> | |
| <DD>If this method returns null, getOutputStream() must return non-null. | |
| Get the writer that this writer sends its output to. | |
| It is possible that the Writer returned by this method does not | |
| implement the WriterChain interface. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getOutputStream()"><!-- --></A><H3> | |
| getOutputStream</H3> | |
| <PRE> | |
| java.io.OutputStream <A HREF="../../../../src-html/org/apache/xml/serializer/WriterChain.html#line.81"><B>getOutputStream</B></A>()</PRE> | |
| <DL> | |
| <DD>If this method returns null, getWriter() must return non-null. | |
| Get the OutputStream that this writer sends its output to. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WriterChain.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xml/serializer/Version.html" title="class in org.apache.xml.serializer"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xml/serializer/WriterToASCI.html" title="class in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xml/serializer/WriterChain.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="WriterChain.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |