/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/annotations/XStreamConverter.html
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> 8XStreamConverter (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="XStreamConverter (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/XStreamConverter.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/annotations/XStreamContainedType.html" title="annotation in com.thoughtworks.xstream.annotations"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/thoughtworks/xstream/annotations/XStreamConverter.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XStreamConverter.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: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</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.annotations</FONT> 93<BR> 94Annotation Type XStreamConverter</H2> 95<HR> 96<DL> 97<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>) 98<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>}) 99<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> 100</FONT>public @interface <B>XStreamConverter</B></DL> 101</PRE> 102 103<P> 104Annotation to declare a converter. The annotation supports additionally the injection of 105 various constructor arguments provided by XStream: 106 <ul> 107 <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 108 instance.</li> 109 <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 110 objects.</li> 111 <li><A HREF="../../../../com/thoughtworks/xstream/converters/reflection/ReflectionProvider.html" title="interface in com.thoughtworks.xstream.converters.reflection"><CODE>ReflectionProvider</CODE></A>: The reflection 112 provider used by the reflection based converters of the current XStream instance.</li> 113 <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 114 argument is not supported when using 115 <A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><CODE>XStreamConverters</CODE></A>.</li> 116 </ul> 117 <p> 118 Note, the annotation matches a <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters"><CODE>ConverterMatcher</CODE></A>. 119 <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters"><CODE>ConverterMatcher</CODE></A> as well as 120 <A HREF="../../../../com/thoughtworks/xstream/converters/SingleValueConverter.html" title="interface in com.thoughtworks.xstream.converters"><CODE>SingleValueConverter</CODE></A> extend this interface. The 121 <A HREF="../../../../com/thoughtworks/xstream/mapper/AnnotationMapper.html" title="class in com.thoughtworks.xstream.mapper"><CODE>AnnotationMapper</CODE></A> can only handle these two 122 <strong>known</strong> types. 123 </p> 124<P> 125 126<P> 127<DL> 128<DT><B>Author:</B></DT> 129 <DD>Chung-Onn Cheong, Jörg Schaible</DD> 130</DL> 131<HR> 132 133<P> 134<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 135 136<A NAME="annotation_type_required_element_summary"><!-- --></A> 137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 140<B>Required Element Summary</B></FONT></TH> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 144<CODE> <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><? extends <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters">ConverterMatcher</A>></CODE></FONT></TD> 145<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverter.html#value()">value</A></B></CODE> 146 147<BR> 148 </TD> 149</TR> 150</TABLE> 151 152<P> 153 154<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 155 156<A NAME="annotation_type_element_detail"><!-- --></A> 157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 158<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 159<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 160<B>Element Detail</B></FONT></TH> 161</TR> 162</TABLE> 163 164<A NAME="value()"><!-- --></A><H3> 165value</H3> 166<PRE> 167public 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><? extends <A HREF="../../../../com/thoughtworks/xstream/converters/ConverterMatcher.html" title="interface in com.thoughtworks.xstream.converters">ConverterMatcher</A>> <B>value</B></PRE> 168<DL> 169<DD><DL> 170</DL> 171</DD> 172<DD><DL> 173</DL> 174</DL> 175<!-- ========= END OF CLASS DATA ========= --> 176<HR> 177 178 179<!-- ======= START OF BOTTOM NAVBAR ====== --> 180<A NAME="navbar_bottom"><!-- --></A> 181<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 182<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 183<TR> 184<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 185<A NAME="navbar_bottom_firstrow"><!-- --></A> 186<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 187 <TR ALIGN="center" VALIGN="top"> 188 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 189 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 190 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 191 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XStreamConverter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 192 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 193 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 194 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 195 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 196 </TR> 197</TABLE> 198</TD> 199<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 200</EM> 201</TD> 202</TR> 203 204<TR> 205<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 206 <A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamContainedType.html" title="annotation in com.thoughtworks.xstream.annotations"><B>PREV CLASS</B></A> 207 <A HREF="../../../../com/thoughtworks/xstream/annotations/XStreamConverters.html" title="annotation in com.thoughtworks.xstream.annotations"><B>NEXT CLASS</B></A></FONT></TD> 208<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 209 <A HREF="../../../../index.html?com/thoughtworks/xstream/annotations/XStreamConverter.html" target="_top"><B>FRAMES</B></A> 210 <A HREF="XStreamConverter.html" target="_top"><B>NO FRAMES</B></A> 211 <SCRIPT type="text/javascript"> 212 <!-- 213 if(window==top) { 214 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 215 } 216 //--> 217</SCRIPT> 218<NOSCRIPT> 219 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 220</NOSCRIPT> 221 222 223</FONT></TD> 224</TR> 225<TR> 226<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 227 SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 228<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 229DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 230</TR> 231</TABLE> 232<A NAME="skip-navbar_bottom"></A> 233<!-- ======== END OF BOTTOM NAVBAR ======= --> 234 235<HR> 236Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 237</BODY> 238</HTML>