mirror of
https://github.com/etesync/android
synced 2025-07-04 22:02:37 +00:00
1510 lines
66 KiB
HTML
1510 lines
66 KiB
HTML
<!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_37) on Mon Feb 18 20:39:44 EST 2013 -->
|
|
<TITLE>
|
|
Serializer
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2013-02-18">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Serializer";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<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> </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="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/simpleframework/xml/Root.html" title="annotation in org.simpleframework.xml"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../org/simpleframework/xml/Text.html" title="annotation in org.simpleframework.xml"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/simpleframework/xml/Serializer.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Serializer.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.simpleframework.xml</FONT>
|
|
<BR>
|
|
Interface Serializer</H2>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/simpleframework/xml/core/Persister.html" title="class in org.simpleframework.xml.core">Persister</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>Serializer</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
The <code>Serializer</code> interface is used to represent objects
|
|
that can serialize and deserialize objects to an from XML. This
|
|
exposes several <code>read</code> and <code>write</code> methods
|
|
that can read from and write to various sources. Typically an
|
|
object will be read from an XML file and written to some other
|
|
file or stream.
|
|
<p>
|
|
An implementation of the <code>Serializer</code> interface is free
|
|
to use any desired XML parsing framework. If a framework other
|
|
than the Java streaming API for XML is required then it should be
|
|
wrapped within the <code>org.simpleframework.xml.stream</code> API,
|
|
which offers a framework neutral facade.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Niall Gallagher</DD>
|
|
</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>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.File)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.File source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.File, boolean)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.File source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, org.simpleframework.xml.stream.InputNode)">read</A></B>(java.lang.Class<? extends T> type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, org.simpleframework.xml.stream.InputNode, boolean)">read</A></B>(java.lang.Class<? extends T> type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.InputStream)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.InputStream source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.InputStream, boolean)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.InputStream source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.Reader)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.Reader source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.io.Reader, boolean)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.io.Reader source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.lang.String)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.lang.String source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(java.lang.Class, java.lang.String, boolean)">read</A></B>(java.lang.Class<? extends T> type,
|
|
java.lang.String source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.File)">read</A></B>(T value,
|
|
java.io.File source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.File, boolean)">read</A></B>(T value,
|
|
java.io.File source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, org.simpleframework.xml.stream.InputNode)">read</A></B>(T value,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, org.simpleframework.xml.stream.InputNode, boolean)">read</A></B>(T value,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.InputStream)">read</A></B>(T value,
|
|
java.io.InputStream source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.InputStream, boolean)">read</A></B>(T value,
|
|
java.io.InputStream source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.Reader)">read</A></B>(T value,
|
|
java.io.Reader source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.io.Reader, boolean)">read</A></B>(T value,
|
|
java.io.Reader source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.lang.String)">read</A></B>(T value,
|
|
java.lang.String source)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
|
|
<TR ALIGN="right" VALIGN="">
|
|
<TD NOWRAP><FONT SIZE="-1">
|
|
<CODE><T> T</CODE></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#read(T, java.lang.String, boolean)">read</A></B>(T value,
|
|
java.lang.String source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.File)">validate</A></B>(java.lang.Class type,
|
|
java.io.File source)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.File, boolean)">validate</A></B>(java.lang.Class type,
|
|
java.io.File source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, org.simpleframework.xml.stream.InputNode)">validate</A></B>(java.lang.Class type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, org.simpleframework.xml.stream.InputNode, boolean)">validate</A></B>(java.lang.Class type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.InputStream)">validate</A></B>(java.lang.Class type,
|
|
java.io.InputStream source)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.InputStream, boolean)">validate</A></B>(java.lang.Class type,
|
|
java.io.InputStream source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.Reader)">validate</A></B>(java.lang.Class type,
|
|
java.io.Reader source)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.io.Reader, boolean)">validate</A></B>(java.lang.Class type,
|
|
java.io.Reader source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.lang.String)">validate</A></B>(java.lang.Class type,
|
|
java.lang.String source)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Serializer.html#validate(java.lang.Class, java.lang.String, boolean)">validate</A></B>(java.lang.Class type,
|
|
java.lang.String source,
|
|
boolean strict)</CODE>
|
|
|
|
<BR>
|
|
This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema.</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/simpleframework/xml/Serializer.html#write(java.lang.Object, java.io.File)">write</A></B>(java.lang.Object source,
|
|
java.io.File out)</CODE>
|
|
|
|
<BR>
|
|
This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.</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/simpleframework/xml/Serializer.html#write(java.lang.Object, org.simpleframework.xml.stream.OutputNode)">write</A></B>(java.lang.Object source,
|
|
<A HREF="../../../org/simpleframework/xml/stream/OutputNode.html" title="interface in org.simpleframework.xml.stream">OutputNode</A> root)</CODE>
|
|
|
|
<BR>
|
|
This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.</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/simpleframework/xml/Serializer.html#write(java.lang.Object, java.io.OutputStream)">write</A></B>(java.lang.Object source,
|
|
java.io.OutputStream out)</CODE>
|
|
|
|
<BR>
|
|
This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.</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/simpleframework/xml/Serializer.html#write(java.lang.Object, java.io.Writer)">write</A></B>(java.lang.Object source,
|
|
java.io.Writer out)</CODE>
|
|
|
|
<BR>
|
|
This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.</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="read(java.lang.Class, java.lang.String)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.lang.String source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.File)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.File source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.InputStream)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.InputStream source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.Reader)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.Reader source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, org.simpleframework.xml.stream.InputNode)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.lang.String, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.lang.String source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.File, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.File source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.InputStream, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.InputStream source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, java.io.Reader, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
java.io.Reader source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Class, org.simpleframework.xml.stream.InputNode, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(java.lang.Class<? extends T> type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and convert it into an object
|
|
of the specified type. If the XML source cannot be deserialized
|
|
or there is a problem building the object graph an exception
|
|
is thrown. The instance deserialized is returned.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be deserialized from XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the object deserialized from the XML document
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.lang.String)"><!-- --></A><A NAME="read(T, java.lang.String)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.lang.String source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.File)"><!-- --></A><A NAME="read(T, java.io.File)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.File source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.InputStream)"><!-- --></A><A NAME="read(T, java.io.InputStream)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.InputStream source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.Reader)"><!-- --></A><A NAME="read(T, java.io.Reader)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.Reader source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,org.simpleframework.xml.stream.InputNode)"><!-- --></A><A NAME="read(T, org.simpleframework.xml.stream.InputNode)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.lang.String,boolean)"><!-- --></A><A NAME="read(T, java.lang.String, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.lang.String source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.File,boolean)"><!-- --></A><A NAME="read(T, java.io.File, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.File source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.InputStream,boolean)"><!-- --></A><A NAME="read(T, java.io.InputStream, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.InputStream source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,java.io.Reader,boolean)"><!-- --></A><A NAME="read(T, java.io.Reader, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
java.io.Reader source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="read(java.lang.Object,org.simpleframework.xml.stream.InputNode,boolean)"><!-- --></A><A NAME="read(T, org.simpleframework.xml.stream.InputNode, boolean)"><!-- --></A><H3>
|
|
read</H3>
|
|
<PRE>
|
|
<T> T <B>read</B>(T value,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>read</code> method will read the contents of the XML
|
|
document from the provided source and populate the object with
|
|
the values deserialized. This is used as a means of injecting an
|
|
object with values deserialized from an XML document. If the
|
|
XML source cannot be deserialized or there is a problem building
|
|
the object graph an exception is thrown.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the object to deserialize the XML in to<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>the same instance provided is returned when finished
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the object cannot be fully deserialized</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.lang.String)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.lang.String source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.File)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.File source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.InputStream)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.InputStream source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.Reader)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.Reader source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, org.simpleframework.xml.stream.InputNode)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.lang.String, boolean)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.lang.String source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.File, boolean)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.File source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.InputStream, boolean)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.InputStream source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, java.io.Reader, boolean)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
java.io.Reader source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.lang.Class, org.simpleframework.xml.stream.InputNode, boolean)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
boolean <B>validate</B>(java.lang.Class type,
|
|
<A HREF="../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> source,
|
|
boolean strict)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>validate</code> method will validate the contents of
|
|
the XML document against the specified XML class schema. This is
|
|
used to perform a read traversal of the class schema such that
|
|
the document can be tested against it. This is preferred to
|
|
reading the document as it does not instantiate the objects or
|
|
invoke any callback methods, thus making it a safe validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> - this is the class type to be validated against XML<DD><CODE>source</CODE> - this provides the source of the XML document<DD><CODE>strict</CODE> - this determines whether to read in strict mode
|
|
<DT><B>Returns:</B><DD>true if the document matches the class XML schema
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the class XML schema does not fully match</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="write(java.lang.Object, java.io.File)"><!-- --></A><H3>
|
|
write</H3>
|
|
<PRE>
|
|
void <B>write</B>(java.lang.Object source,
|
|
java.io.File out)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.
|
|
This uses the <code>getClass</code> method on the object to
|
|
determine the class file that will be used to compose the schema.
|
|
If there is no <code>Root</code> annotation for the class then
|
|
this will throw an exception. The root annotation is the only
|
|
annotation required for an object to be serialized.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - this is the object that is to be serialized<DD><CODE>out</CODE> - this is where the serialized XML is written to
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the schema for the object is not valid</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="write(java.lang.Object, java.io.OutputStream)"><!-- --></A><H3>
|
|
write</H3>
|
|
<PRE>
|
|
void <B>write</B>(java.lang.Object source,
|
|
java.io.OutputStream out)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.
|
|
This uses the <code>getClass</code> method on the object to
|
|
determine the class file that will be used to compose the schema.
|
|
If there is no <code>Root</code> annotation for the class then
|
|
this will throw an exception. The root annotation is the only
|
|
annotation required for an object to be serialized.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - this is the object that is to be serialized<DD><CODE>out</CODE> - this is where the serialized XML is written to
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the schema for the object is not valid</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="write(java.lang.Object, java.io.Writer)"><!-- --></A><H3>
|
|
write</H3>
|
|
<PRE>
|
|
void <B>write</B>(java.lang.Object source,
|
|
java.io.Writer out)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.
|
|
This uses the <code>getClass</code> method on the object to
|
|
determine the class file that will be used to compose the schema.
|
|
If there is no <code>Root</code> annotation for the class then
|
|
this will throw an exception. The root annotation is the only
|
|
annotation required for an object to be serialized.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - this is the object that is to be serialized<DD><CODE>out</CODE> - this is where the serialized XML is written to
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the schema for the object is not valid</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="write(java.lang.Object, org.simpleframework.xml.stream.OutputNode)"><!-- --></A><H3>
|
|
write</H3>
|
|
<PRE>
|
|
void <B>write</B>(java.lang.Object source,
|
|
<A HREF="../../../org/simpleframework/xml/stream/OutputNode.html" title="interface in org.simpleframework.xml.stream">OutputNode</A> root)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This <code>write</code> method will traverse the provided object
|
|
checking for field annotations in order to compose the XML data.
|
|
This uses the <code>getClass</code> method on the object to
|
|
determine the class file that will be used to compose the schema.
|
|
If there is no <code>Root</code> annotation for the class then
|
|
this will throw an exception. The root annotation is the only
|
|
annotation required for an object to be serialized.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - this is the object that is to be serialized<DD><CODE>root</CODE> - this is where the serialized XML is written to
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - if the schema for the object is not valid</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="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/simpleframework/xml/Root.html" title="annotation in org.simpleframework.xml"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../org/simpleframework/xml/Text.html" title="annotation in org.simpleframework.xml"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/simpleframework/xml/Serializer.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Serializer.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>
|