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

http://prototipomemoria.googlecode.com/ · HTML · 233 lines · 187 code · 26 blank · 20 comment · 0 complexity · 585964ae4002e67b4d427773741cf6e3 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. FieldKeySorter (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="FieldKeySorter (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/FieldKeySorter.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/reflection/FieldKey.html" title="class in com.thoughtworks.xstream.converters.reflection"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/HarmonyReflectionProvider.html" title="class in com.thoughtworks.xstream.converters.reflection"><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/reflection/FieldKeySorter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="FieldKeySorter.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.reflection</FONT>
  82. <BR>
  83. Interface FieldKeySorter</H2>
  84. <DL>
  85. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/ImmutableFieldKeySorter.html" title="class in com.thoughtworks.xstream.converters.reflection">ImmutableFieldKeySorter</A>, <A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/NativeFieldKeySorter.html" title="class in com.thoughtworks.xstream.converters.reflection">NativeFieldKeySorter</A>, <A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/SortableFieldKeySorter.html" title="class in com.thoughtworks.xstream.converters.reflection">SortableFieldKeySorter</A>, <A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/XStream12FieldKeySorter.html" title="class in com.thoughtworks.xstream.converters.reflection">XStream12FieldKeySorter</A></DD>
  86. </DL>
  87. <HR>
  88. <DL>
  89. <DT><PRE>public interface <B>FieldKeySorter</B></DL>
  90. </PRE>
  91. <P>
  92. An interface capable of sorting fields. Implement this interface if you want to customize the
  93. field order in which XStream serializes objects.
  94. <P>
  95. <P>
  96. <DL>
  97. <DT><B>Since:</B></DT>
  98. <DD>1.2.2</DD>
  99. <DT><B>Author:</B></DT>
  100. <DD>Guilherme Silveira</DD>
  101. </DL>
  102. <HR>
  103. <P>
  104. <!-- ========== METHOD SUMMARY =========== -->
  105. <A NAME="method_summary"><!-- --></A>
  106. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  107. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  108. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  109. <B>Method Summary</B></FONT></TH>
  110. </TR>
  111. <TR BGCOLOR="white" CLASS="TableRowColor">
  112. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  113. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A></CODE></FONT></TD>
  114. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/FieldKeySorter.html#sort(java.lang.Class, java.util.Map)">sort</A></B>(<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>&nbsp;type,
  115. <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;keyedByFieldKey)</CODE>
  116. <BR>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sort the fields of a type.</TD>
  118. </TR>
  119. </TABLE>
  120. &nbsp;
  121. <P>
  122. <!-- ============ METHOD DETAIL ========== -->
  123. <A NAME="method_detail"><!-- --></A>
  124. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  126. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  127. <B>Method Detail</B></FONT></TH>
  128. </TR>
  129. </TABLE>
  130. <A NAME="sort(java.lang.Class, java.util.Map)"><!-- --></A><H3>
  131. sort</H3>
  132. <PRE>
  133. <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> <B>sort</B>(<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>&nbsp;type,
  134. <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;keyedByFieldKey)</PRE>
  135. <DL>
  136. <DD>Sort the fields of a type. The method will be called with the class type that contains
  137. all the fields and a Map that retains the order in which the elements have been added.
  138. The sequence in which elements are returned by an iterator defines the processing order
  139. of the fields. An implementation may create a different Map with similar semantic, add
  140. all elements of the original map and return the new one.
  141. <P>
  142. <DD><DL>
  143. <DT><B>Parameters:</B><DD><CODE>type</CODE> - the class that contains all the fields<DD><CODE>keyedByFieldKey</CODE> - a Map containing a <A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/FieldKey.html" title="class in com.thoughtworks.xstream.converters.reflection"><CODE>FieldKey</CODE></A> as key element and a
  144. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect"><CODE>Field</CODE></A> as value.
  145. <DT><B>Returns:</B><DD>a Map with all the entries of the original Map<DT><B>Since:</B></DT>
  146. <DD>1.2.2</DD>
  147. </DL>
  148. </DD>
  149. </DL>
  150. <!-- ========= END OF CLASS DATA ========= -->
  151. <HR>
  152. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  153. <A NAME="navbar_bottom"><!-- --></A>
  154. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  155. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  156. <TR>
  157. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  158. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  159. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  160. <TR ALIGN="center" VALIGN="top">
  161. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  162. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  163. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  164. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FieldKeySorter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  165. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  166. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  167. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  168. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  169. </TR>
  170. </TABLE>
  171. </TD>
  172. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  173. </EM>
  174. </TD>
  175. </TR>
  176. <TR>
  177. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  178. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/FieldKey.html" title="class in com.thoughtworks.xstream.converters.reflection"><B>PREV CLASS</B></A>&nbsp;
  179. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/converters/reflection/HarmonyReflectionProvider.html" title="class in com.thoughtworks.xstream.converters.reflection"><B>NEXT CLASS</B></A></FONT></TD>
  180. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  181. <A HREF="../../../../../index.html?com/thoughtworks/xstream/converters/reflection/FieldKeySorter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  182. &nbsp;<A HREF="FieldKeySorter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  183. &nbsp;<SCRIPT type="text/javascript">
  184. <!--
  185. if(window==top) {
  186. document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  187. }
  188. //-->
  189. </SCRIPT>
  190. <NOSCRIPT>
  191. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  192. </NOSCRIPT>
  193. </FONT></TD>
  194. </TR>
  195. <TR>
  196. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  197. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  198. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  199. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  200. </TR>
  201. </TABLE>
  202. <A NAME="skip-navbar_bottom"></A>
  203. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  204. <HR>
  205. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
  206. </BODY>
  207. </HTML>