mirrors
/
org.aspectj
mirror of https://github.com/eclipse/org.aspectj.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 138 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8627 Commits
38 Branches
Tree: b08d7d2a31
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'b08d7d2a31'
${ noResults }
org.aspectj/docs/dist/doc/index.html

index.html 14KB
Raw Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359 
  1. <html>

  2. <head>

  3.   <title>AspectJ Documentation and Resources</title>

  4. </head>

  5. <body>

  6. 

  7. <a name="top"></a>

  8. <h1>AspectJ Documentation and Resources</h1>

  9. <p/>

  10.     AspectJ <sup><small>tm</small></sup>

  11.     is a seamless aspect-oriented extension to

  12.     Java<sup><small>tm</small></sup>.

  13.     The compiler and development tools are available under

  14.     an open-source license, require Java 1.3 to run, and produce

  15.     code that runs in JDK 1.1 and later VM's.

  16.     For the latest materials, see

  17.     <a href="http://eclipse.org/aspectj">http://eclipse.org/aspectj</a>.

  18.     Not all of these materials have been updated for AspectJ 5.

  19. <p/>

  20. 

  21. <table>

  22.     <tr><td><u>Section</u></td><td><u>Contents</u></td></tr>

  23.     <tr><td><a href="#documentation">docs</a></td><td>

  24.        <a href="faq.html">FAQ</a>,

  25.        <a href="quick5.pdf">Quick Reference (AspectJ 5)</a>,

  26.        <a href="quick.pdf">Quick Reference (1.2.1)</a>,

  27.        <a href="adk15notebook/index.html">AspectJ 5 Developer's Notebook</a>,

  28.        <a href="progguide/index.html">programming</a>,

  29.        <a href="devguide/index.html">development</a> and

  30.        <a href="pdguide/index.html">problem diagnosis</a> guides,

  31.        <a href="runtime-api/index.html">API</a> and

  32.        <a href="examples/">example code</a>.

  33. 	   </td></tr>

  34.     <tr><td><a href="#distributions">distributions</a></td><td>

  35.         <a href="http://eclipse.org/aspectj">AspectJ</a>;

  36.         development environment support for

  37.         <a href="http://eclipse.org/ajdt">Eclipse</a>

  38.         and

  39.         <a href="https://jdeveloperaop.dev.java.net/">JDeveloper</a>.

  40.         </td></tr>

  41.     <tr><td><a href="#resources">resources</a></td><td>

  42.        <a href="http://aosd.net">aosd.net</a>;

  43.        <a href="http://eclipse.org/aspectj">AspectJ project</a>

  44.        the bug <a href="http://bugs.eclipse.org/bugs">db</a>,

  45.        and mailing lists for

  46.        <a href="mailto:aspectj-users@eclipse.org">users</a> and

  47.        <a href="mailto:aspectj-dev@eclipse.org">developers</a>.

  48. 	   </td></tr>

  49.     <tr><td><a href="#paths">paths</a> </td><td>for those new to AspectJ

  50. 		</td></tr>

  51. </table>

  52. <p/>

  53. 

  54. <a name="documentation"></a>

  55. <h3>AspectJ documentation</h3>

  56. <table border="1">

  57. <tr> <th>Documentation</th><th>Description</th>

  58.      </tr>

  59. 

  60. 

  61. <tr> <td><a href="quick5.pdf"> AspectJ 5 Quick Reference</a>

  62.      </td>

  63.      <td>This is a four-page quick reference for the AspectJ 5 language.

  64.      </td> </tr>

  65. 

  66. <tr> <td><a href="quick.pdf"> AspectJ Quick Reference</a>

  67.      </td>

  68.      <td>This is a two-page quick reference for the AspectJ language.

  69.      </td> </tr>

  70. 

  71. <tr> <td><a href="adk15notebook/index.html">AspectJ 5 Developer's Notebook</a>

  72.          (printable <a href="adk15notebook/printable.html">html</a>)

  73.      </td>

  74.      <td>This describes the changes to the AspectJ language and tools introduced

  75.      in the AspectJ 5 Development Kit. These changes are additive, and are not yet

  76.      reflected in the programming guide or quick reference.</td>

  77.      </tr>

  78. 

  79. <tr> <td><a href="progguide/index.html">Programming Guide</a>

  80.          (printable <a href="progguide/printable.html">html</a>)

  81.      </td>

  82.      <td>This introduces AOP and the AspectJ language.

  83.       <a href="progguide/starting.html">Getting Started</a>

  84.      describes basic semantics, and shows development- and production-time applications.

  85.      <a href="progguide/language.html">The AspectJ Language</a>

  86.      describes join points, pointcuts, advice, and introduction, all features new to AOP.

  87.      <a href="progguide/examples.html">Examples</a> walks you through the

  88.      examples included with the documentation, and there are two short

  89.      chapters on useful <a href="progguide/idioms.html">Idioms</a> and a

  90.      few <a href="progguide/pitfalls.html">Pitfalls</a>

  91.      The appendices have reference information:

  92.      the <a href="progguide/quick.html">Quick Reference</a>

  93.      summarizes AspectJ syntax,

  94.      the <a href="progguide/semantics.html">Language Semantics</a>

  95.      best describes AspectJ usage, and

  96.      <a href="progguide/implementation.html">Implementation Notes</a>

  97.      describes how

  98.      the current version is limited to code the compiler controls.</td>

  99.      </tr>

  100. 

  101. <tr> <td><a href="devguide/index.html">Development Environment Guide</a>

  102. <br/>

  103. 

  104.          (printable <a href="devguide/printable.html">html</a>)

  105.      </td>

  106.      <td>This is a guide to

  107.      <a href="devguide/ajc-ref.html">ajc</a>, the command-line compiler;

  108.      and the <a href="devguide/antTasks.html">Ant tasks</a>

  109.      for building AspectJ programs.

  110.      </td>

  111.      </tr>

  112. 

  113. <tr> <td><a href="pdguide/index.html">Problem Diagnosis Guide</a>

  114. <br/>

  115. 

  116.          (printable <a href="pdguide/printable.html">html</a>)

  117.      </td>

  118.      <td>This has a guide to

  119.      the various features available such as messages and trace to help you both solve problems

  120.      with you own programs and report bugs to the AspectJ team.

  121.      </td>

  122.      </tr>

  123. 

  124. <tr> <td><a href="runtime-api/index.html">AspectJ API</a>

  125.      </td>

  126.      <td>API documentation for AspectJ runtime classes. <tt>JoinPoint</tt>

  127.          shows the state automatically available at each join point.

  128. 		 See also the <a href="weaver-api/index.html">Weaver API</a>

  129.      </td> </tr>

  130. 

  131. <tr> <td><a href="faq.html"> FAQ</a>

  132.      </td>

  133.      <td>Frequently-asked questions about the AspectJ language, tools, and project.

  134.      </td> </tr>

  135. 

  136. <tr> <td>README's

  137.      </td>

  138.      <td>Changes and porting guide for AspectJ

  139.         <a href="README-1919.html">1.9.19</a>,

  140.         <a href="README-199.html">1.9.9 and 1.9.9.1</a>,

  141.         <a href="README-198.html">1.9.8</a>,

  142.         <a href="README-197.html">1.9.7</a>,

  143.         <a href="README-196.html">1.9.6</a>,

  144.         <a href="README-195.html">1.9.5</a>,

  145.         <a href="README-194.html">1.9.4</a>,

  146.         <a href="README-193.html">1.9.3</a>,

  147.         <a href="README-192.html">1.9.2</a>,

  148.         <a href="README-191.html">1.9.1</a>,

  149.         <a href="README-190.html">1.9.0</a>,

  150.         <a href="README-1811.html">1.8.11</a>,

  151.         <a href="README-1810.html">1.8.10</a>,

  152.         <a href="README-189.html">1.8.9</a>,

  153.         <a href="README-188.html">1.8.8</a>,

  154.         <a href="README-187.html">1.8.7</a>,

  155.         <a href="README-186.html">1.8.6</a>,

  156.         <a href="README-185.html">1.8.5</a>,

  157.         <a href="README-184.html">1.8.4</a>,

  158.         <a href="README-183.html">1.8.3</a>,

  159.         <a href="README-182.html">1.8.2</a>,

  160.         <a href="README-181.html">1.8.1</a>,

  161.         <a href="README-180.html">1.8.0</a>,

  162.         <a href="README-174.html">1.7.4</a>,

  163.         <a href="README-173.html">1.7.3</a>,

  164.         <a href="README-172.html">1.7.2</a>,

  165.         <a href="README-171.html">1.7.1</a>,

  166.         <a href="README-170.html">1.7.0</a>,

  167.         <a href="README-1612.html">1.6.12</a>,

  168.         <a href="README-1611.html">1.6.11</a>,

  169.         <a href="README-1610.html">1.6.10</a>,

  170.         <a href="README-169.html">1.6.9</a>,

  171.         <a href="README-168.html">1.6.8</a>,

  172.         <a href="README-167.html">1.6.7</a>,

  173.         <a href="README-166.html">1.6.6</a>,

  174.         <a href="README-165.html">1.6.5</a>,

  175.         <a href="README-164.html">1.6.4</a>,

  176.         <a href="README-163.html">1.6.3</a>,

  177.         <a href="README-162.html">1.6.2</a>,

  178.         <a href="README-161.html">1.6.1</a>,

  179.         <a href="README-160.html">1.6.0</a>,

  180.         <a href="README-154.html">1.5.4</a>,

  181.         <a href="README-153.html">1.5.3</a>,

  182.         <a href="README-152.html">1.5.2</a>,

  183.         <a href="README-151.html">1.5.1</a>,

  184.         <a href="README-150.html">1.5.0</a>,

  185. 		<a href="README-121.html">1.2.1</a>,

  186. 		<a href="README-12.html">1.2.0</a>,

  187. 		<a href="README-11.html">1.1</a>, and

  188. 		<a href="porting.html">1.0</a>.

  189.      </td> </tr>

  190. 

  191. 

  192. <tr> <td><a href="changes.html">Changes</a>

  193.      </td>

  194.      <td>Changes between the latest releases.

  195.      </td> </tr>

  196. 

  197. <tr> <td><a href="examples/">Examples</a>

  198.      </td>

  199.      <td>AspectJ code to demonstrate some language features and implement

  200.      JavaBean properties, the Observer pattern, a tracing library,

  201.      and a game application where aspects handle display updating.

  202.      </td> </tr>

  203. 

  204. </table>

  205. 

  206. <a name="distributions"></a>

  207. <h3>AspectJ distributions</h3>

  208. <table border="1">

  209. <tr> <th>Distributions</th><th>Description</th></tr>

  210. <tr> <td><a href="http://eclipse.org/aspectj">AspectJ</a>

  211.      </td>

  212.      <td>The AspectJ distribution contains binaries for the

  213.          compiler, structure browser, and Ant taskdefs,

  214.          as well as the documentation and examples.

  215.          </td>

  216.      </tr>

  217. <tr> <td><a href="http://eclipse.org/aspectj">AspectJ</a> source code

  218.      </td>

  219.      <td>Source code for AspectJ is available

  220.          under the open-source

  221.          <a href="https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt">Eclipse Public License v 2.0</a>

  222.          license from the Git

  223.          repositories for the AspectJ project. See the

  224.          <a href="faq.html#q:buildingsource">FAQ entry</a>.

  225.          </td>

  226.      </tr>

  227. 

  228. <tr> <td><a href="http://eclipse.org/ajdt">AspectJ for Eclipse</a>

  229.      </td>

  230.      <td>AspectJ Development Environment support for

  231.          Eclipse is available under Eclipse Public License v 1.0

  232.          from the eclipse.org project site

  233.          <a href="http://eclipse.org/ajdt">

  234.                   http://eclipse.org/ajdt</a>

  235.          </td>

  236.      </tr>

  237. 

  238. <tr> <td><a href="https://jdeveloperaop.dev.java.net/">

  239.           Support for the JDeveloper IDE</a>

  240.      </td>

  241.      <td>Support for programming in AspectJ using the JDeveloper IDE

  242.          is available under the Apache Software License

  243.          from the java.net project site

  244.          <a href="https://jdeveloperaop.dev.java.net/">

  245.                   https://jdeveloperaop.dev.java.net/</a>

  246.          </td>

  247.      </tr>

  248. 

  249. </table>

  250. 

  251. <a name="resources"></a>

  252. <h3>Other AspectJ resources</h3>

  253. <table border="1">

  254. <tr> <th>Resources</th><th>Description</th>

  255.      </tr>

  256. <tr> <td>Mail lists

  257.          </td>

  258.      <td>

  259.          AspectJ users discuss tips and

  260.          best practices for writing AspectJ programs on

  261.          <a href="mailto:aspectj-users@eclipse.org">

  262.            aspectj-users@eclipse.org</a>.

  263.          AspectJ developers discuss issues with developing

  264.          the AspectJ tools on

  265.          <a href="mailto:aspectj-dev@eclipse.org">

  266.           aspectj-dev@eclipse.org</a>.

  267.          To get occasional emails about AspectJ releases

  268.          and relevant events, subscribe to

  269.          <tt>aspectj-announce@eclipse.org</tt>.

  270.          To view list archives or subscribe to the list, go to

  271.          <a href="http://eclipse.org/aspectj">

  272.                  the AspectJ home page</a>.

  273. 		 To find archived emails, use the Eclipse site

  274. 		 <a href="http://www.eclipse.org/search/search.cgi">search page</a>.

  275. 	</td></tr>

  276. <tr> <td><a href="http://bugs.eclipse.org/bugs">Bug database</a>

  277.      </td>

  278.      <td>Use the Eclipse project's Bugzilla database

  279.      to view and submit bugs against the AspectJ product components

  280.      <a href="http://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&amp;component=Compiler">

  281.          Compiler</a> (for the AspectJ compiler, ajc)

  282.      <a href="http://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&amp;component=IDE">

  283.          IDE</a> (for AJBrowser and AJDE bugs),

  284.      <a href="http://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&amp;component=Ant">

  285.          Ant</a> (for the Ant tasks),

  286.      and

  287.      <a href="http://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&amp;component=Docs">

  288.          Docs</a> (for the documentation).

  289.      Bugs all users should know about are

  290.      <a href="http://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&amp;keywords=info">

  291.       flagged with the "info" keyword</a>.

  292.      See the

  293.      <a href="faq.html#q:ajcbugs">

  294.      	FAQ entry</a> for instructions on submitting compiler bugs.

  295.      </td> </tr>

  296. 

  297. <tr> <td> <a href="http://aosd.net">http://aosd.net</a> - the AOSD web site

  298.      </td>

  299.      <td>This site has discussion and announcements related to

  300.          aspect-oriented software development (AOSD) in general.

  301.          Use <a href="mailto:announce@aosd.net">announce@aosd.net</a>

  302.          to get and publish notices about AOSD

  303.          workshops, conferences, and technology releases.

  304.          Use <a href="mailto:discuss@aosd.net">discuss@aosd.net</a>

  305.          for general AOSD discussions.

  306.      </td> </tr>

  307. </table>

  308. 

  309. <p/>

  310. <a name="paths"></a>

  311. <h3>Suggested paths for those new to AspectJ</h3>

  312. <p/>

  313.    To learn the AspectJ language, read the

  314.     <a href="progguide/index.html">Programming Guide</a>,

  315.     keeping the <a href="progguide/semantics.html">Semantics appendix</a>

  316.     nearby as the best reference for AspectJ usage.

  317.     Focus initially on the join point model and

  318.     pointcuts, concepts AOP adds to OOP.

  319.     To read about how the <a href="examples/">examples</a> work,

  320.     see the <a href="progguide/examples.html">Examples </a> section

  321.     in the <a href="progguide/index.html">Programming Guide</a>.

  322.     View and navigate the crosscutting structure using

  323.     <a href="http://eclipse.org/ajdt">AJDT (AspectJ Development Tools)

  324.     in Eclipse IDE</a>. IntelliJ IDEA also offers AspectJ and Spring AOP

  325.     support.

  326. <p/>

  327.     To start using AspectJ with your own code,

  328.     modify the example aspects to apply to your classes.

  329.     As you learn,

  330.     use the compiler's <code>-Xlint</code> flags to catch some common

  331.     mistakes.  (Understand that the

  332.     <a href="progguide/implementation.html">current implementation</a>

  333.     is limited to code the compiler controls.)

  334. <p>

  335.    To plan how to adopt AspectJ into a project, read the

  336.     <a href="progguide/index.html">Programming Guide</a>

  337.    on development- and production-time aspects

  338.    and the <a href="faq.html">FAQ</a> entries for

  339.    <a href="faq.html#q:startUsingAJ">How should I start using AspectJ?</a>,

  340.    <a href="faq.html#adoption">Deciding to adopt AspectJ</a>,

  341.    the Development tools sections

  342.    (<a href="faq.html#q:integrateWithDevTools">one</a>,

  343.     <a href="faq.html#devtools">two</a>,

  344.     <a href="faq.html#ltw">Load-time weaving</a>

  345.     ), and

  346.    <a href="faq.html#q:opensource">AspectJ as open-source</a>.

  347. </p>

  348. <p>

  349. Enjoy the language!

  350. </p>

  351. <p>

  352. The AspectJ Team

  353. </p>

  354. 

  355. <hr/>

  356. <small>

  357. <a href="#top">Top</a>

  358. </small>

  359. </body> </html>