From: wisberg Date: Fri, 2 Apr 2004 11:22:00 +0000 (+0000) Subject: Jan's 4/2 bug 50932 patch X-Git-Tag: Root_ajdt_support~71 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=8362834a932f63a0ac5d25d52898b658d2fe2b81;p=aspectj.git Jan's 4/2 bug 50932 patch --- diff --git a/docs/sandbox/ubc-design-patterns/docs/readme-1.1.pdf b/docs/sandbox/ubc-design-patterns/docs/readme-1.1.pdf deleted file mode 100644 index 89d5db0d4..000000000 Binary files a/docs/sandbox/ubc-design-patterns/docs/readme-1.1.pdf and /dev/null differ diff --git a/docs/sandbox/ubc-design-patterns/docs/readme-1.1.txt b/docs/sandbox/ubc-design-patterns/docs/readme-1.1.txt deleted file mode 100644 index 4be660c35..000000000 --- a/docs/sandbox/ubc-design-patterns/docs/readme-1.1.txt +++ /dev/null @@ -1,59 +0,0 @@ -Implementations of GoF Design Patterns in Java and AspectJ -Code base documentation (March 2, 2004) - - -Overview -The goal was to provide parallel implementations in AspectJ and Java that allow for direct comparisons. It has to be noted that most patterns offer variability in the implementation approach. We choose the one that appeared to be the most general. Sometimes, the AspectJ version implements a slightly different (or additional) case(s). This is due to the fact that AJ sometimes allows for additional functionality. Please refer to the web page and our OOPSLA '02 paper for a detailed description of this work. - -Example Setup -All pattern examples have a class called Main. This class is the driver for the particular example. The Main classes are extensively documented using ajdoc, describing the experimental setup and the assignment of roles to participants. In most cases, the differences between Java and AspectJ implementations are also mentioned. - -Documentation (ajdoc) -While all files are extensively documented using ajdoc (the AspectJ version of javadoc), ajdoc is not yet compatible with the later AspectJ releases, so it is currently not possible to generate HTML documents from it. This will be added when ajdoc is updated. -Within the ajdoc documentation, we tried to separate type names used in our examples from role names (as presented in GoF). We show roles names in italics and actual type names in code font. - -Questions, feedback, suggestions, etc. -The AODP web page is http://www.cs.ubc.ca/labs/spl/projects/aodps.html -Please send all questions, feedback, and suggestions to Jan Hannemann (jan@cs.ubc.ca). We are very much interested in improving our code. Please do not hesitate to drop us a line. - - -=============================== - - -Appendix -This appendix outlines how to compile and run the examples provided. DOS batch files exist that automate these tasks somewhat. Note that the batch files only work in Windows environments. The following is a list of tasks and a description of what commands accomplish them. For compiling, running and generating documentation, two options are given. The first one is using a provided script; the second is the standard command-line option (longer, but will work on all operation systems). - - -A1: Using the Eclipse IDE -Setting up your system and running the examples -1. Install Eclipse (www.eclipse.org) and AJDT (www.eclipse.org/ajdt). Currently AJDT only works with release 2.1.X and not with version 3.0+ of Eclipse. Check the AJDT web page for more information and updates. -2. Create a new AspectJ project -3. Import the ZIP file with the AOP pattern examples into your project -4. Set the source directory to "Design Pattern Examples/src" (under: Project / Properties / Java Build Path / Source). Set/adjust the output directory is desired. -5. Compile -6. Run individual examples by selecting the appropriate source folder and selecting Run As / Java Application. - - -A2: Using other AspectJ-compatible IDEs -Note: the code base has not been tested with other IDEs. Chances are that this will work similar to the above, though. - - -A3: Using command-line compilation -Setting up your system -1. Install Java (version 1.4+) and AspectJ (version 1.1+) -2. Extract the ZIP file into a directory of your choice -3. Make sure your CLASSPATH contains the example's src directory -4. Change to that directory - -Compile Java and AspectJ versions the design pattern examples. Choose one: -* Use the buildAllPatterns batch file (just call it from the examples root directory. Needs no arguments). -* ajc -d bin @src/allPatterns.lst - -Run a compiled example (e.g. observer). Choose one: -* testPattern observer (this runs both Java and AspectJ versions) -* java ca.ubc.cs.spl.aspectPatterns.examples.observer.java.Main (for the Java version), -java ca.ubc.cs.spl.aspectPatterns.examples.observer.java.Main (for the AspectJ version) - - - March 2, 2004 - diff --git a/docs/sandbox/ubc-design-patterns/docs/readme.pdf b/docs/sandbox/ubc-design-patterns/docs/readme.pdf new file mode 100644 index 000000000..cde37b24b Binary files /dev/null and b/docs/sandbox/ubc-design-patterns/docs/readme.pdf differ diff --git a/docs/sandbox/ubc-design-patterns/docs/readme.txt b/docs/sandbox/ubc-design-patterns/docs/readme.txt new file mode 100644 index 000000000..8908cf8b6 --- /dev/null +++ b/docs/sandbox/ubc-design-patterns/docs/readme.txt @@ -0,0 +1,55 @@ +Implementations of GoF Design Patterns in Java and AspectJ +Code base documentation (April 2, 2004) + + +Overview +The goal was to provide parallel implementations in AspectJ and Java that allow for direct comparisons. It has to be noted that most patterns offer variability in the implementation approach. We choose the one that appeared to be the most general. Sometimes, the AspectJ version implements a slightly different (or additional) case(s). This is due to the fact that AJ sometimes allows for additional functionality. Please refer to the web page and our OOPSLA '02 paper for a detailed description of this work. + +Example Setup +All pattern examples have a class called Main. This class is the driver for the particular example. The Main classes are extensively documented using ajdoc, describing the experimental setup and the assignment of roles to participants. In most cases, the differences between Java and AspectJ implementations are also mentioned. + +Documentation (ajdoc) +While all files are extensively documented using ajdoc (the AspectJ version of javadoc), ajdoc is not yet compatible with the later AspectJ releases, so it is currently not possible to generate HTML documents from it. This will be added when ajdoc is updated. +Within the ajdoc documentation, we tried to separate type names used in our examples from role names (as presented in GoF). We show roles names in italics and actual type names in code font. + +Questions, feedback, suggestions, etc. +The AODP web page is http://www.cs.ubc.ca/labs/spl/aodp.html +Please send all questions, feedback, and suggestions to Jan Hannemann (jan [AT] cs.ubc.ca). We are very much interested in improving our code. Please do not hesitate to drop us a line. + + +=============================== + + +Appendix +This appendix outlines how to compile and run the examples provided. DOS batch files exist that automate these tasks somewhat. Note that the batch files only work in Windows environments. The following is a list of tasks and a description of what commands accomplish them. For compiling, running and generating documentation, two options are given. The first one is using a provided script; the second is the standard command-line option (longer, but will work on all operation systems). + + +A1: Using the Eclipse IDE +Setting up your system and running the examples +1. Install Eclipse (www.eclipse.org) and AJDT (www.eclipse.org/ajdt). Currently AJDT only works with release 2.1.X and not with version 3.0+ of Eclipse. Check the AJDT web page for more information and updates. +2. Import the ZIP file with the AOP pattern examples into Eclipse +3. Compile & run + + +A2: Using other AspectJ-compatible IDEs +Note: the code base has not been tested with other IDEs. Chances are that this will work similar to the above, though. + + +A3: Using command-line compilation +Setting up your system +1. Install Java (version 1.4+) and AspectJ (version 1.1+) +2. Extract the ZIP file into a directory of your choice +3. Make sure your CLASSPATH contains the example's src directory +4. Change to that directory + +Compile Java and AspectJ versions the design pattern examples. Choose one: +* Use the buildAllPatterns batch file (just call it from the examples root directory. Needs no arguments). +* ajc -d bin @src/allPatterns.lst + +Run a compiled example (e.g. observer). Choose one: +* testPattern observer (this runs both Java and AspectJ versions) +* java ca.ubc.cs.spl.aspectPatterns.examples.observer.java.Main (for the Java version), +java ca.ubc.cs.spl.aspectPatterns.examples.observer.java.Main (for the AspectJ version) + + + April 2, 2004 diff --git a/docs/sandbox/ubc-design-patterns/patterns-test.xml b/docs/sandbox/ubc-design-patterns/patterns-test.xml index 717162536..be5f4f4b6 100644 --- a/docs/sandbox/ubc-design-patterns/patterns-test.xml +++ b/docs/sandbox/ubc-design-patterns/patterns-test.xml @@ -14,7 +14,7 @@ - + - + + +