arno/etesync-android
1
0
Fork 0
mirror of https://github.com/etesync/android synced 2025-06-05 07:38:49 +00:00
Code Issues Releases Wiki Activity
350171c20c
etesync-android/libs/biweekly-0.3.1-javadoc/biweekly/Biweekly.WriterChainXml.html

445 lines
25 KiB
HTML
Raw Blame History

<!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.6.0_51) on Sat Sep 21 17:46:21 EDT 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Biweekly.WriterChainXml (biweekly 0.3.1 API)
</TITLE>
<META NAME="date" CONTENT="2013-09-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../syntaxhighlighter.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Biweekly.WriterChainXml (biweekly 0.3.1 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<script src="doc-files/shCore.js" type="text/javascript"></script> <script src="doc-files/shBrushJava.js" type="text/javascript"></script><HR>
<!-- ========= 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Biweekly.WriterChainXml.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../biweekly/Biweekly.WriterChainText.html" title="class in biweekly"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../biweekly/ICalDataType.html" title="class in biweekly"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?biweekly/Biweekly.WriterChainXml.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Biweekly.WriterChainXml.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
biweekly</FONT>
<BR>
Class Biweekly.WriterChainXml</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>biweekly.Biweekly.WriterChainXml</B>
</PRE>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../biweekly/Biweekly.html" title="class in biweekly">Biweekly</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public static class <A HREF="../src-html/biweekly/Biweekly.html#line.1247"><B>Biweekly.WriterChainXml</B></A><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
Chainer class for writing xCal documents (XML-encoded iCalendar objects).
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../biweekly/Biweekly.html#writeXml(java.util.Collection)"><CODE>Biweekly.writeXml(Collection)</CODE></A>,
<A HREF="../biweekly/Biweekly.html#writeXml(biweekly.ICalendar...)"><CODE>Biweekly.writeXml(ICalendar...)</CODE></A></DL>
<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>&nbsp;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#dom()">dom</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the xCal document to an XML DOM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#go()">go</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the xCal document to a string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#go(java.io.File)">go</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the xCal document to a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#go(java.io.OutputStream)">go</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the xCal document to an output stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#go(java.io.Writer)">go</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A>&nbsp;writer)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the xCal document to a writer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#indent(int)">indent</A></B>(int&nbsp;indent)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of indent spaces to use for pretty-printing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#register(biweekly.component.marshaller.ICalComponentMarshaller)">register</A></B>(<A HREF="../biweekly/component/marshaller/ICalComponentMarshaller.html" title="class in biweekly.component.marshaller">ICalComponentMarshaller</A>&lt;? extends <A HREF="../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>&gt;&nbsp;marshaller)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers a component marshaller.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#register(biweekly.property.marshaller.ICalPropertyMarshaller)">register</A></B>(<A HREF="../biweekly/property/marshaller/ICalPropertyMarshaller.html" title="class in biweekly.property.marshaller">ICalPropertyMarshaller</A>&lt;? extends <A HREF="../biweekly/property/ICalProperty.html" title="class in biweekly.property">ICalProperty</A>&gt;&nbsp;marshaller)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers a property marshaller.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../biweekly/Biweekly.WriterChainXml.html#register(java.lang.String, biweekly.ICalDataType)">register</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;parameterName,
<A HREF="../biweekly/ICalDataType.html" title="class in biweekly">ICalDataType</A>&nbsp;dataType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers the data type of an experimental parameter.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="register(biweekly.property.marshaller.ICalPropertyMarshaller)"><!-- --></A><H3>
register</H3>
<PRE>
public <A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1256"><B>register</B></A>(<A HREF="../biweekly/property/marshaller/ICalPropertyMarshaller.html" title="class in biweekly.property.marshaller">ICalPropertyMarshaller</A>&lt;? extends <A HREF="../biweekly/property/ICalProperty.html" title="class in biweekly.property">ICalProperty</A>&gt;&nbsp;marshaller)</PRE>
<DL>
<DD>Registers a property marshaller.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>marshaller</CODE> - the marshaller
<DT><B>Returns:</B><DD>this</DL>
</DD>
</DL>
<HR>
<A NAME="register(biweekly.component.marshaller.ICalComponentMarshaller)"><!-- --></A><H3>
register</H3>
<PRE>
public <A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1261"><B>register</B></A>(<A HREF="../biweekly/component/marshaller/ICalComponentMarshaller.html" title="class in biweekly.component.marshaller">ICalComponentMarshaller</A>&lt;? extends <A HREF="../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>&gt;&nbsp;marshaller)</PRE>
<DL>
<DD>Registers a component marshaller.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>marshaller</CODE> - the marshaller
<DT><B>Returns:</B><DD>this</DL>
</DD>
</DL>
<HR>
<A NAME="register(java.lang.String, biweekly.ICalDataType)"><!-- --></A><H3>
register</H3>
<PRE>
public <A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1272"><B>register</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;parameterName,
<A HREF="../biweekly/ICalDataType.html" title="class in biweekly">ICalDataType</A>&nbsp;dataType)</PRE>
<DL>
<DD>Registers the data type of an experimental parameter. Experimental
parameters use the "unknown" xCal data type by default.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameterName</CODE> - the parameter name (e.g. "x-foo")<DD><CODE>dataType</CODE> - the data type
<DT><B>Returns:</B><DD>this</DL>
</DD>
</DL>
<HR>
<A NAME="indent(int)"><!-- --></A><H3>
indent</H3>
<PRE>
public <A HREF="../biweekly/Biweekly.WriterChainXml.html" title="class in biweekly">Biweekly.WriterChainXml</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1283"><B>indent</B></A>(int&nbsp;indent)</PRE>
<DL>
<DD>Sets the number of indent spaces to use for pretty-printing. If not
set, then the XML will not be pretty-printed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>indent</CODE> - the number of spaces
<DT><B>Returns:</B><DD>this</DL>
</DD>
</DL>
<HR>
<A NAME="go()"><!-- --></A><H3>
go</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1296"><B>go</B></A>()</PRE>
<DL>
<DD>Writes the xCal document to a string.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the XML string
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the marshaller class for a
component or property object cannot be found (only happens when an
experimental property/component marshaller is not registered with the
<code>register</code> method.)</DL>
</DD>
</DL>
<HR>
<A NAME="go(java.io.OutputStream)"><!-- --></A><H3>
go</H3>
<PRE>
public void <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1315"><B>go</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE>
<DL>
<DD>Writes the xCal document to an output stream.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - the output stream to write to
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the marshaller class for a
component or property object cannot be found (only happens when an
experimental property/component marshaller is not registered with the
<code>register</code> method.)
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if there's a problem writing the XML</DL>
</DD>
</DL>
<HR>
<A NAME="go(java.io.File)"><!-- --></A><H3>
go</H3>
<PRE>
public void <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1330"><B>go</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A>,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Writes the xCal document to a file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to write to
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the marshaller class for a
component or property object cannot be found (only happens when an
experimental property/component marshaller is not registered with the
<code>register</code> method.)
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if there's a problem writing the XML
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's a problem writing to the file</DL>
</DD>
</DL>
<HR>
<A NAME="go(java.io.Writer)"><!-- --></A><H3>
go</H3>
<PRE>
public void <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1344"><B>go</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A>&nbsp;writer)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE>
<DL>
<DD>Writes the xCal document to a writer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - the writer to write to
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the marshaller class for a
component or property object cannot be found (only happens when an
experimental property/component marshaller is not registered with the
<code>register</code> method.)
<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if there's a problem writing the XML</DL>
</DD>
</DL>
<HR>
<A NAME="dom()"><!-- --></A><H3>
dom</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A> <A HREF="../src-html/biweekly/Biweekly.WriterChainXml.html#line.1353"><B>dom</B></A>()</PRE>
<DL>
<DD>Writes the xCal document to an XML DOM.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the XML DOM</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Biweekly.WriterChainXml.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["gutter"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.defaults["toolbar"] = false; SyntaxHighlighter.all(); </script></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../biweekly/Biweekly.WriterChainText.html" title="class in biweekly"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../biweekly/ICalDataType.html" title="class in biweekly"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?biweekly/Biweekly.WriterChainXml.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Biweekly.WriterChainXml.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2013 Michael Angstadt. All Rights Reserved.
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink