utils/jalopy/docs/sorting.html

   1
   2     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   3   <html><head>
   4       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5    <title>4.3.12.&nbsp;Sorting</title><link rel="stylesheet" href="site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="manual.html" title="Jalopy User Manual"><link rel="up" href="printer.html" title="4.3.&nbsp;Printer"><link rel="previous" href="footer.html" title="4.3.11.&nbsp;Footer"><link rel="next" href="misc.html" title="4.3.13.&nbsp;Misc"><link rel="preface" href="dedication.html" title="Dedication"><link rel="preface" href="acknowledge.html" title="Acknowledgements"><link rel="preface" href="introduction.html" title="Introduction"><link rel="part" href="part-core.html" title="Part&nbsp;I.&nbsp;Jalopy core"><link rel="chapter" href="installation.html" title="Chapter&nbsp;1.&nbsp;Installation"><link rel="chapter" href="build.html" title="Chapter&nbsp;2.&nbsp;Building"><link rel="chapter" href="usage.html" title="Chapter&nbsp;3.&nbsp;Usage"><link rel="chapter" href="settings.html" title="Chapter&nbsp;4.&nbsp;Settings"><link rel="part" href="part-plugins.html" title="Part&nbsp;II.&nbsp;Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter&nbsp;5.&nbsp;Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter&nbsp;6.&nbsp;Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter&nbsp;7.&nbsp;Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter&nbsp;8.&nbsp;JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter&nbsp;9.&nbsp;JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter&nbsp;10.&nbsp;jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter&nbsp;11.&nbsp;NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix&nbsp;A.&nbsp;Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix&nbsp;B.&nbsp;The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix&nbsp;C.&nbsp;ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix&nbsp;D.&nbsp;The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix&nbsp;E.&nbsp;GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix&nbsp;F.&nbsp;GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix&nbsp;G.&nbsp;Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix&nbsp;H.&nbsp;SUN PUBLIC LICENSE Version 1.0"><link rel="index" href="ix01.html" title="Index"><link rel="subsection" href="sorting.html#sorting-general" title="4.3.12.1.&nbsp;Declarations"><link rel="subsection" href="sorting.html#d0e4876" title="4.3.12.2.&nbsp;Modifiers">
   6       <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
   7       <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" l gen true for "http://jalopy.sf.net" r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://jalopy.sf.net" r (n 0 s 0 v 0 l 0))'>
   8     </head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="left"><tbody><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./index.html" class="navlink">Overview</a> &#149;
   9                     <a href="./download.html" class="navlink">Download</a> &#149;
  10                     <a href="./docs.html" class="navlink">Documentation</a> &#149;
  11                     <a href="./plugins.html" class="navlink">Plug-ins</a> &#149;
  12                     <a href="./links.html" class="navlink">Links</a> &#149;
  13                     <a href="./contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td height="20" bgcolor="#faebd7" style="padding-left:15px"><a href="./features.html" class="navlink2">Features</a> |
  14                     <a href="./history.html" class="navlink2">History</a> |
  15                     <a href="./manual.html" class="navlink2">Manual</a> |
  16                     <a href="./faq.html" class="navlink2">FAQ</a> |
  17                     <a href="./api/index.html" class="navlink2">Javadoc</a></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" align="right" style="font-size:10px;padding-right:3px">
  18                     This page generated: <strong>June 8 2004</strong></td></tr></tbody></table><table border="0" width="100%" cellspacing="0" cellpadding="5"><tr><td><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.3.12.&nbsp;Sorting</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="footer.html">Prev</a>&nbsp;</td><th width="60%" align="center">4.3.&nbsp;Printer</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="misc.html">Next</a></td></tr></table><hr></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sorting"></a>4.3.12.&nbsp;Sorting</h3></div></div><div></div></div><p>Lets you tweak the sorting settings.</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="sorting-general"></a>4.3.12.1.&nbsp;Declarations</h4></div></div><div></div></div><p>
  19 At first glance, sorting of class declaration elements may seem somewhat
  20 obscure, but good sorting can lead to a reduction of complexity if the
  21 location of each element is predictable.
  22 </p><div class="itemizedlist"><ul type="disc"><li><p><a name="sorting-general-elements"></a>
  23 Sort class elements
  24 </p><p>
  25 Enables or disables the sorting of class elements.
  26 </p><div class="example"><a name="ex-sort-file"></a><p class="title"><b>Example&nbsp;4.149.&nbsp;Sorted Java source file (with <a href="separation.html#separation-comment" title="4.3.5.3.&nbsp;Comments">Separator comments</a>)</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">
  27 class TypePrinter
  28     extends AbstractPrinter
  29 {
  30     //~ Instance/static variables ----------------------------------------------
  31
  32     /** Singleton. */
  33     private final static Printer INSTANCE = new TypePrinter();
  34
  35     //~ Constructors -----------------------------------------------------------
  36
  37     /**
  38      * Creates a new TypePrinter object.
  39      */
  40     protected TypePrinter()
  41     {
  42     }
  43
  44     //~ Methods ----------------------------------------------------------------
  45
  46     public static Printer getInstance()
  47     {
  48         return INSTANCE;
  49     }
  50
  51     public void print(AST node, ASTWriter out)
  52                throws IOException
  53     {
  54         AST child = node.getFirstChild();
  55         PrinterFactory.create(child).print(child, out);
  56     }
  57 }
  58 </pre></td></tr></table></div><p></p></li><li><p>Ordering</p><p>
  59 You can specify the order in which static variable/initializer, instance variable,
  60 instance initializer, constructor, method, inner class and interface elements
  61 should appear in source files by selecting the element type and moving it up or
  62 down the list.
  63 </p><p>
  64 If you enable any of the check boxes, all elements of the selected type
  65 (within a section) will be sorted too. First by access modifier
  66 (public, protected, package protected, private) and - for two elements with the
  67 same accessibility - lexicographically. For methods those which follow the Java
  68 Bean pattern (getXXX, setXXX, isXXX) will be sorted first.
  69 </p></li></ul></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4876"></a>4.3.12.2.&nbsp;Modifiers</h4></div></div><div></div></div><p><a name="sorting-modifier"></a>
  70 Enables or disables the sorting of declaration modifiers.
  71 </p><div class="itemizedlist"><ul type="disc"><li><p>Ordering</p><p>
  72 Lets you specify the order in which the individual modifiers should appear.
  73 Select an entry and use the <span><b class="guibutton">Up</b></span> and <span><b class="guibutton">Down</b></span>
  74 buttons to move it to the desired location.
  75 </p></li></ul></div><p></p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="footer.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="printer.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="misc.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3.11.&nbsp;Footer&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;4.3.13.&nbsp;Misc</td></tr></table></div></td></tr></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
  76             Copyright &copy; 2001-2004, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>