/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/converters/ErrorWriter.html

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