<!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_18) on Sat Dec 04 05:26:33 UTC 2010 -->
<TITLE>
Unmarshaller
</TITLE>
<META NAME="date" CONTENT="2010-12-04">
<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="Unmarshaller";
}
}
</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="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/bind/UnmarshallerHandler.html" title="interface in javax.xml.bind"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/bind/Unmarshaller.html" target="_top"><B>FRAMES</B></A>
<A HREF="Unmarshaller.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">
javax.xml.bind</FONT>
<BR>
Interface Unmarshaller</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/apache/ws/jaxme/JMUnmarshaller.html" title="interface in org.apache.ws.jaxme">JMUnmarshaller</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html" title="class in javax.xml.bind.helpers">AbstractUnmarshallerImpl</A>, <A HREF="../../../org/apache/ws/jaxme/impl/JMUnmarshallerImpl.html" title="class in org.apache.ws.jaxme.impl">JMUnmarshallerImpl</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Unmarshaller</B></DL>
</PRE>
<P>
<p>A <code>Unmarshaller</code> is the opposite of the <A HREF="../../../javax/xml/bind/Marshaller.html" title="interface in javax.xml.bind"><CODE>Marshaller</CODE></A>:
It takes as input XML in either of several representations (byte or
character stream, DOM node, or a series of SAX events) and returns
a JAXB object with the same contents.</p>
<p>If the JAXB user demands, the <code>Unmarshaller</code> may also
validate the content tree that it sees.</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>JAXB1.0</DD>
<DT><B>Author:</B></DT>
<DD>JSR-31</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/bind/JAXBContext.html" title="class in javax.xml.bind"><CODE>JAXBContext</CODE></A>,
<A HREF="../../../javax/xml/bind/Marshaller.html" title="interface in javax.xml.bind"><CODE>Marshaller</CODE></A>,
<A HREF="../../../javax/xml/bind/Validator.html" title="interface in javax.xml.bind"><CODE>Validator</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> <A HREF="../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#getEventHandler()">getEventHandler</A></B>()</CODE>
<BR>
If the JAXB application has registered a custom handler
for validation events, returns that handler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String pName)</CODE>
<BR>
Returnss the unmarshaller property <code>pName</code> to the value
<code>pValue</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/xml/bind/UnmarshallerHandler.html" title="interface in javax.xml.bind">UnmarshallerHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#getUnmarshallerHandler()">getUnmarshallerHandler</A></B>()</CODE>
<BR>
Returns a SAX 2 <CODE>ContentHandler</CODE>, which is
able to parse a SAX event stream and convert it into a JAXB
object.</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="../../../javax/xml/bind/Unmarshaller.html#isValidating()">isValidating</A></B>()</CODE>
<BR>
Sets whether the <code>Unmarshaller</code> is validating
the objects that it reads.</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="../../../javax/xml/bind/Unmarshaller.html#setEventHandler(javax.xml.bind.ValidationEventHandler)">setEventHandler</A></B>(<A HREF="../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</A> pHandler)</CODE>
<BR>
An application may customize the Unmarshallers behaviour
in case of validation problems by supplying a custom handler
for validation events.</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="../../../javax/xml/bind/Unmarshaller.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String pName,
java.lang.Object pValue)</CODE>
<BR>
Sets the unmarshaller property <code>pName</code> to the value
<code>pValue</code>.</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="../../../javax/xml/bind/Unmarshaller.html#setValidating(boolean)">setValidating</A></B>(boolean pValidating)</CODE>
<BR>
Sets whether the <code>Unmarshaller</code> is validating
the objects that it reads.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.File)">unmarshal</A></B>(java.io.File pFile)</CODE>
<BR>
This method takes opens the given file <code>pFile</code>
for input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.xml.sax.InputSource)">unmarshal</A></B>(org.xml.sax.InputSource pSource)</CODE>
<BR>
The Unmarshaller reads the byte stream or character
stream referred by the <CODE>InputSource</CODE>
and converts it into an equivalent JAXB object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.InputStream)">unmarshal</A></B>(java.io.InputStream pStream)</CODE>
<BR>
The Unmarshaller reads the given byte stream
and converts it into an equivalent JAXB object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.w3c.dom.Node)">unmarshal</A></B>(org.w3c.dom.Node pNode)</CODE>
<BR>
The Unmarshaller converts the given node into an equivalent
JAXB object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source)">unmarshal</A></B>(javax.xml.transform.Source pSource)</CODE>
<BR>
The Unmarshaller reads the XML representation from the given
<CODE>Source</CODE> and converts it into an equivalent JAXB object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.net.URL)">unmarshal</A></B>(java.net.URL pURL)</CODE>
<BR>
This method takes connects to the given <code>pURL</code>
and opens a byte stream for input.</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="unmarshal(java.io.File)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(java.io.File pFile)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>This method takes opens the given file <code>pFile</code>
for input. The Unmarshaller reads the byte stream contained in
the file and converts it into an equivalent JAXB object.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pFile</CODE> - The file being read.
<DT><B>Returns:</B><DD>The JAXB object read from the file.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem (for example an
IOException) occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read from the byte stream for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="unmarshal(java.io.InputStream)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(java.io.InputStream pStream)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>The Unmarshaller reads the given byte stream
and converts it into an equivalent JAXB object.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pStream</CODE> - The stream being read.
<DT><B>Returns:</B><DD>The JAXB object read from the byte stream.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem (for example an
IOException) occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read from the byte stream for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="unmarshal(java.net.URL)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(java.net.URL pURL)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>This method takes connects to the given <code>pURL</code>
and opens a byte stream for input. The Unmarshaller reads the
byte stream and converts it into an equivalent JAXB object.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pURL</CODE> - The URL being read.
<DT><B>Returns:</B><DD>The JAXB object read from the URL.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem (for example an
IOException) occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read from the byte stream for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="unmarshal(org.xml.sax.InputSource)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(org.xml.sax.InputSource pSource)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>The Unmarshaller reads the byte stream or character
stream referred by the <CODE>InputSource</CODE>
and converts it into an equivalent JAXB object.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pSource</CODE> - The <CODE>InputSource</CODE> referring to a byte or
character stream. It is recommended, that the system ID is
set. This may be required, if the XML in the stream refers
to external entities.
<DT><B>Returns:</B><DD>The JAXB object read from the byte or character stream.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem (for example an
IOException) occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read from the byte stream for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="unmarshal(org.w3c.dom.Node)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(org.w3c.dom.Node pNode)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>The Unmarshaller converts the given node into an equivalent
JAXB object.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pNode</CODE> - The node to convert. The JAXB provider must support
documents and elements. Other node types may not work
(document fragments) or cannot work (attributes, text nodes,
and so on).
<DT><B>Returns:</B><DD>The JAXB object read from the DOM node.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="unmarshal(javax.xml.transform.Source)"><!-- --></A><H3>
unmarshal</H3>
<PRE>
java.lang.Object <B>unmarshal</B>(javax.xml.transform.Source pSource)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>The Unmarshaller reads the XML representation from the given
<CODE>Source</CODE> and converts it into an equivalent JAXB object.</p>
<p>The JAXB provider must support at least
<CODE>SAXSource</CODE>,
<CODE>DOMSource</CODE>, and
<CODE>StreamSource</CODE>. A possible
implementation could validate whether the argument is actually
an instance of these subinterfaces. If so, it might simply
act like
<A HREF="../../../javax/xml/bind/Unmarshaller.html#getUnmarshallerHandler()"><CODE>getUnmarshallerHandler()</CODE></A>,
<A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.w3c.dom.Node)"><CODE>unmarshal(org.w3c.dom.Node)</CODE></A>,
<A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.InputStream)"><CODE>unmarshal(java.io.InputStream)</CODE></A>, or
<A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.xml.sax.InputSource)"><CODE>unmarshal(org.xml.sax.InputSource)</CODE></A>, respectively.</p>
<p><em>Note</em>: If you are not using the standard JAXP
mechanism for obtaining an <CODE>XMLReader</CODE>,
then you might create your own SAX parser and invoke the
<code>pSource</code> arguments
<CODE>SAXSource.setXMLReader(org.xml.sax.XMLReader)</CODE>.
The JAXB provider will detect and use your SAX parser.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pSource</CODE> - The <CODE>Source</CODE> being read.
<DT><B>Returns:</B><DD>The JAXB object read from the DOM node.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - An unexpected problem occurred.
<DD><CODE><A HREF="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</A></CODE> - The JAXB object is invalid or could
not be read for similar reasons.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="getUnmarshallerHandler()"><!-- --></A><H3>
getUnmarshallerHandler</H3>
<PRE>
<A HREF="../../../javax/xml/bind/UnmarshallerHandler.html" title="interface in javax.xml.bind">UnmarshallerHandler</A> <B>getUnmarshallerHandler</B>()
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>Returns a SAX 2 <CODE>ContentHandler</CODE>, which is
able to parse a SAX event stream and convert it into a JAXB
object. This is particularly useful in a stack of SAX
handlers. (Think of Apache Cocoon.)</p>
<p><em>Note</em>: The JAXB provider may choose to return the
same handler again, if the method is invoked more than once.
In other words, if you need to have multiple handlers (for
example, because you have multiple threads), then you should
create multiple <code>Unmarshallers</code>.</p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setValidating(boolean)"><!-- --></A><H3>
setValidating</H3>
<PRE>
void <B>setValidating</B>(boolean pValidating)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>Sets whether the <code>Unmarshaller</code> is validating
the objects that it reads. The default is false.</p>
<p><em>Note</em>: A validating unmarshaller will rarely use
a validating SAX parser by default! It does so, because the
SAX parsers validation and the Unmarshallers builtin
validation would most probably validate the same things,
resulting in no additional safety at the cost of wasting
performance. Second, a SAX parser is not always in use.
For example, you do not need a parser when
converting a DOM Node. If you insist in a validating XML
parser, then you should create your own
<CODE>XMLReader</CODE> and use the method
<A HREF="../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source)"><CODE>unmarshal(javax.xml.transform.Source)</CODE></A>.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pValidating</CODE> - Whether the <code>Unmarshaller</code> should validate
or not.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - Setting the property failed.</DL>
</DD>
</DL>
<HR>
<A NAME="isValidating()"><!-- --></A><H3>
isValidating</H3>
<PRE>
boolean <B>isValidating</B>()
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>Sets whether the <code>Unmarshaller</code> is validating
the objects that it reads. The default is false.</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>True, if the <code>Unmarshaller</code> is validating the objects
that it reads, false otherwise.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - Fetching the property value failed.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/bind/Unmarshaller.html#setValidating(boolean)"><CODE>setValidating(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setEventHandler(javax.xml.bind.ValidationEventHandler)"><!-- --></A><H3>
setEventHandler</H3>
<PRE>
void <B>setEventHandler</B>(<A HREF="../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</A> pHandler)
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>An application may customize the Unmarshallers behaviour
in case of validation problems by supplying a custom handler
for validation events. The default handler will trigger an
exception in case of errors and fatal errors.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pHandler</CODE> - The custom event handler or null to restore
the default event handler.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE> - Setting the handler failed.</DL>
</DD>
</DL>
<HR>
<A NAME="getEventHandler()"><!-- --></A><H3>
getEventHandler</H3>
<PRE>
<A HREF="../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</A> <B>getEventHandler</B>()
throws <A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></PRE>
<DL>
<DD><p>If the JAXB application has registered a custom handler
for validation events, returns that handler. Otherwise returns
the default handler, which is triggering an exception in case
of errors and fatal errors.</p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setProperty</H3>
<PRE>
void <B>setProperty</B>(java.lang.String pName,
java.lang.Object pValue)
throws <A HREF="../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</A></PRE>
<DL>
<DD><p>Sets the unmarshaller property <code>pName</code> to the value
<code>pValue</code>. Note, that the value type depends on the
property being set.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pName</CODE> - The property name.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</A></CODE> - An error occurred while processing the property.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The name parameter was null.</DL>
</DD>
</DL>
<HR>
<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
java.lang.Object <B>getProperty</B>(java.lang.String pName)
throws <A HREF="../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</A></PRE>
<DL>
<DD><p>Returnss the unmarshaller property <code>pName</code> to the value
<code>pValue</code>. Note, that the value type depends on the
property being set.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pName</CODE> - The property name.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</A></CODE> - An error occurred while processing the property.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The name parameter was null.</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="../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/bind/UnmarshallerHandler.html" title="interface in javax.xml.bind"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/bind/Unmarshaller.html" target="_top"><B>FRAMES</B></A>
<A HREF="Unmarshaller.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>
distrib
>
Mandriva
>
2011.0
>
x86_64
>
media
>
main-release
>
by-pkgid
>
a151a9789d7f6da162486c8d892d2428
>
files
>
28
