/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/converters/ErrorWriter.html
HTML | 299 lines | 246 code | 33 blank | 20 comment | 0 complexity | e10f127e5329b62294991fc1d81e78d2 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:25 CEST 2011 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8ErrorWriter (XStream Core 1.4.1 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2011-08-11"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="ErrorWriter (XStream Core 1.4.1 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ErrorWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/thoughtworks/xstream/converters/ErrorWriter.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="ErrorWriter.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.thoughtworks.xstream.converters</FONT> 93<BR> 94Interface ErrorWriter</H2> 95<DL> 96<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/core/AbstractReferenceMarshaller.ReferencedImplicitElementException.html" title="class in com.thoughtworks.xstream.core">AbstractReferenceMarshaller.ReferencedImplicitElementException</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/reflection/AbstractReflectionConverter.DuplicateFieldException.html" title="class in com.thoughtworks.xstream.converters.reflection">AbstractReflectionConverter.DuplicateFieldException</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/reflection/AbstractReflectionConverter.UnknownFieldException.html" title="class in com.thoughtworks.xstream.converters.reflection">AbstractReflectionConverter.UnknownFieldException</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/ConversionException.html" title="class in com.thoughtworks.xstream.converters">ConversionException</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/javabean/JavaBeanConverter.DuplicateFieldException.html" title="class in com.thoughtworks.xstream.converters.javabean">JavaBeanConverter.DuplicateFieldException</A></DD> 97</DL> 98<HR> 99<DL> 100<DT><PRE>public interface <B>ErrorWriter</B></DL> 101</PRE> 102 103<P> 104To aid debugging, some components are passed an ErrorWriter 105 when things go wrong, allowing them to add information 106 to the error message that may be helpful to diagnose problems. 107<P> 108 109<P> 110<DL> 111<DT><B>Author:</B></DT> 112 <DD>Joe Walnes, Jörg Schaible</DD> 113</DL> 114<HR> 115 116<P> 117 118<!-- ========== METHOD SUMMARY =========== --> 119 120<A NAME="method_summary"><!-- --></A> 121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 124<B>Method Summary</B></FONT></TH> 125</TR> 126<TR BGCOLOR="white" CLASS="TableRowColor"> 127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 128<CODE> void</CODE></FONT></TD> 129<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html#add(java.lang.String, java.lang.String)">add</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 130 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> information)</CODE> 131 132<BR> 133 Add some information to the error message.</TD> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 137<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 138<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html#get(java.lang.String)">get</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorKey)</CODE> 139 140<BR> 141 Retrieve information of the error message.</TD> 142</TR> 143<TR BGCOLOR="white" CLASS="TableRowColor"> 144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> 146<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html#keys()">keys</A></B>()</CODE> 147 148<BR> 149 Retrieve an iterator over all keys of the error message.</TD> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 153<CODE> void</CODE></FONT></TD> 154<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html#set(java.lang.String, java.lang.String)">set</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 155 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> information)</CODE> 156 157<BR> 158 Set some information to the error message.</TD> 159</TR> 160</TABLE> 161 162<P> 163 164<!-- ============ METHOD DETAIL ========== --> 165 166<A NAME="method_detail"><!-- --></A> 167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 169<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 170<B>Method Detail</B></FONT></TH> 171</TR> 172</TABLE> 173 174<A NAME="add(java.lang.String, java.lang.String)"><!-- --></A><H3> 175add</H3> 176<PRE> 177void <B>add</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 178 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> information)</PRE> 179<DL> 180<DD>Add some information to the error message. The information will be added even 181 if the identifier is already in use. 182<P> 183<DD><DL> 184<DT><B>Parameters:</B><DD><CODE>name</CODE> - something to identify the type of information (e.g. 'XPath').<DD><CODE>information</CODE> - detail of the message (e.g. '/blah/moo[3]'</DL> 185</DD> 186</DL> 187<HR> 188 189<A NAME="set(java.lang.String, java.lang.String)"><!-- --></A><H3> 190set</H3> 191<PRE> 192void <B>set</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 193 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> information)</PRE> 194<DL> 195<DD>Set some information to the error message. If the identifier is already in use, the 196 new information will replace the old one. 197<P> 198<DD><DL> 199<DT><B>Parameters:</B><DD><CODE>name</CODE> - something to identify the type of information (e.g. 'XPath').<DD><CODE>information</CODE> - detail of the message (e.g. '/blah/moo[3]'<DT><B>Since:</B></DT> 200 <DD>1.4</DD> 201</DL> 202</DD> 203</DL> 204<HR> 205 206<A NAME="get(java.lang.String)"><!-- --></A><H3> 207get</H3> 208<PRE> 209<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>get</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorKey)</PRE> 210<DL> 211<DD>Retrieve information of the error message. 212<P> 213<DD><DL> 214<DT><B>Parameters:</B><DD><CODE>errorKey</CODE> - the key of the message 215<DT><B>Returns:</B><DD>the value<DT><B>Since:</B></DT> 216 <DD>1.3</DD> 217</DL> 218</DD> 219</DL> 220<HR> 221 222<A NAME="keys()"><!-- --></A><H3> 223keys</H3> 224<PRE> 225<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>keys</B>()</PRE> 226<DL> 227<DD>Retrieve an iterator over all keys of the error message. 228<P> 229<DD><DL> 230 231<DT><B>Returns:</B><DD>an Iterator<DT><B>Since:</B></DT> 232 <DD>1.3</DD> 233</DL> 234</DD> 235</DL> 236<!-- ========= END OF CLASS DATA ========= --> 237<HR> 238 239 240<!-- ======= START OF BOTTOM NAVBAR ====== --> 241<A NAME="navbar_bottom"><!-- --></A> 242<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 243<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 244<TR> 245<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 246<A NAME="navbar_bottom_firstrow"><!-- --></A> 247<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 248 <TR ALIGN="center" VALIGN="top"> 249 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 251 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 252 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ErrorWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 253 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 254 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 255 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 256 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 257 </TR> 258</TABLE> 259</TD> 260<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 261</EM> 262</TD> 263</TR> 264 265<TR> 266<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 267 <A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters"><B>PREV CLASS</B></A> 268 <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters"><B>NEXT CLASS</B></A></FONT></TD> 269<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 270 <A HREF="../../../../index.html?com/thoughtworks/xstream/converters/ErrorWriter.html" target="_top"><B>FRAMES</B></A> 271 <A HREF="ErrorWriter.html" target="_top"><B>NO FRAMES</B></A> 272 <SCRIPT type="text/javascript"> 273 <!-- 274 if(window==top) { 275 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 276 } 277 //--> 278</SCRIPT> 279<NOSCRIPT> 280 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 281</NOSCRIPT> 282 283 284</FONT></TD> 285</TR> 286<TR> 287<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 288 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 289<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 290DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 291</TR> 292</TABLE> 293<A NAME="skip-navbar_bottom"></A> 294<!-- ======== END OF BOTTOM NAVBAR ======= --> 295 296<HR> 297Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 298</BODY> 299</HTML>