/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/annotations/XStreamConverter.html

http://prototipomemoria.googlecode.com/ · HTML · 238 lines · 193 code · 25 blank · 20 comment · 0 complexity · 4b27da411a89c1cf095fc0cbdc3f926a 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. XStreamConverter (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="XStreamConverter (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/XStreamConverter.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/annotations/XStreamContainedType.html" title="annotation in com.thoughtworks.xstream.annotations"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../index.html?com/thoughtworks/xstream/annotations/XStreamConverter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XStreamConverter.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;<A HREF="#annotation_type_required_element_summary">REQUIRED</A>&nbsp;|&nbsp;OPTIONAL</FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</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.annotations</FONT>
  82. <BR>
  83. Annotation Type XStreamConverter</H2>
  84. <HR>
  85. <DL>
  86. <DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>)
  87. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>={<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</A>})
  88. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</A>
  89. </FONT>public @interface <B>XStreamConverter</B></DL>
  90. </PRE>
  91. <P>
  92. Annotation to declare a converter. The annotation supports additionally the injection of
  93. various constructor arguments provided by XStream:
  94. <ul>
  95. <li><A HREF="../../../../com/thoughtworks/xstream/mapper/Mapper.html" title="interface in com.thoughtworks.xstream.mapper"><CODE>Mapper</CODE></A>: The current mapper chain of the XStream
  96. instance.</li>
  97. <li><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><CODE>ClassLoader</CODE></A>: The class loader used by the XStream instance to deserialize the
  98. objects.</li>
  99. <li><A HREF="../../../../com/thoughtworks/xstream/converters/reflection/ReflectionProvider.html" title="interface in com.thoughtworks.xstream.converters.reflection"><CODE>ReflectionProvider</CODE></A>: The reflection
  100. provider used by the reflection based converters of the current XStream instance.</li>
  101. <li><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><CODE>Class</CODE></A>: The type of the element where the annotation is declared. Note, that this
  102. argument is not supported when using
  103. <A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><CODE>XStreamConverters</CODE></A>.</li>
  104. </ul>
  105. <p>
  106. Note, the annotation matches a <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters"><CODE>ConverterMatcher</CODE></A>.
  107. <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters"><CODE>ConverterMatcher</CODE></A> as well as
  108. <A HREF="../../../../com/thoughtworks/xstream/converters/SingleValueConverter.html" title="interface in com.thoughtworks.xstream.converters"><CODE>SingleValueConverter</CODE></A> extend this interface. The
  109. <A HREF="../../../../com/thoughtworks/xstream/mapper/AnnotationMapper.html" title="class in com.thoughtworks.xstream.mapper"><CODE>AnnotationMapper</CODE></A> can only handle these two
  110. <strong>known</strong> types.
  111. </p>
  112. <P>
  113. <P>
  114. <DL>
  115. <DT><B>Author:</B></DT>
  116. <DD>Chung-Onn Cheong, J&ouml;rg Schaible</DD>
  117. </DL>
  118. <HR>
  119. <P>
  120. <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
  121. <A NAME="annotation_type_required_element_summary"><!-- --></A>
  122. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  123. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  124. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  125. <B>Required Element Summary</B></FONT></TH>
  126. </TR>
  127. <TR BGCOLOR="white" CLASS="TableRowColor">
  128. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  129. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;? extends <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters">ConverterMatcher</A>&gt;</CODE></FONT></TD>
  130. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverter.html#value()">value</A></B></CODE>
  131. <BR>
  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  133. </TR>
  134. </TABLE>
  135. &nbsp;
  136. <P>
  137. <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
  138. <A NAME="annotation_type_element_detail"><!-- --></A>
  139. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  140. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  141. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  142. <B>Element Detail</B></FONT></TH>
  143. </TR>
  144. </TABLE>
  145. <A NAME="value()"><!-- --></A><H3>
  146. value</H3>
  147. <PRE>
  148. public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;? extends <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters">ConverterMatcher</A>&gt; <B>value</B></PRE>
  149. <DL>
  150. <DD><DL>
  151. </DL>
  152. </DD>
  153. <DD><DL>
  154. </DL>
  155. </DL>
  156. <!-- ========= END OF CLASS DATA ========= -->
  157. <HR>
  158. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  159. <A NAME="navbar_bottom"><!-- --></A>
  160. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  161. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  162. <TR>
  163. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  164. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  165. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  166. <TR ALIGN="center" VALIGN="top">
  167. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  168. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  169. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  170. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XStreamConverter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  171. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  172. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  173. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  174. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  175. </TR>
  176. </TABLE>
  177. </TD>
  178. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  179. </EM>
  180. </TD>
  181. </TR>
  182. <TR>
  183. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  184. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamContainedType.html" title="annotation in com.thoughtworks.xstream.annotations"><B>PREV CLASS</B></A>&nbsp;
  185. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><B>NEXT CLASS</B></A></FONT></TD>
  186. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  187. <A HREF="../../../../index.html?com/thoughtworks/xstream/annotations/XStreamConverter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  188. &nbsp;<A HREF="XStreamConverter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  189. &nbsp;<SCRIPT type="text/javascript">
  190. <!--
  191. if(window==top) {
  192. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  193. }
  194. //-->
  195. </SCRIPT>
  196. <NOSCRIPT>
  197. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  198. </NOSCRIPT>
  199. </FONT></TD>
  200. </TR>
  201. <TR>
  202. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  203. SUMMARY:&nbsp;<A HREF="#annotation_type_required_element_summary">REQUIRED</A>&nbsp;|&nbsp;OPTIONAL</FONT></TD>
  204. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  205. DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
  206. </TR>
  207. </TABLE>
  208. <A NAME="skip-navbar_bottom"></A>
  209. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  210. <HR>
  211. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
  212. </BODY>
  213. </HTML>