JML Documentation Index

Please use the headings below to find the information you need.

1. JML Documentation
   • Local documentation (on this computer)
     • Introductory and overview documents
     • More detailed and reference material on the JML language
     • Samples
     • Package documentation
     • Tool documentation
     • Information for implementers of JML
   • Non-Local documentation
   • Getting help with JML
     • Questions and Bug Reports
     • General Comments and Discussions
2. Acknowledgments

1. JML Documentation

Local documentation (on this computer)

The following documentation is part of the JML release and should be on this computer.

The README.html file for the release.

Introductory and overview documents

• Gary T. Leavens and Yoonsik Cheon. Design by Contract with JML. (Tutorial for JML in PDF format.)
• Gary T. Leavens, Albert L. Baker, and Clyde Ruby. JML: a Notation for Detailed Design. In Haim Kilov, Bernhard Rumpe, and Ian Simmonds (editors), Behavioral Specifications for Businesses and Systems, chapter 12, pages 175-188. Copyright (c) Kluwer Academic Publishers, 1999, used by permission.

See also the samples and package documentation below.

More detailed and reference material on the JML language

• Gary T. Leavens, Albert L. Baker, and Clyde Ruby. Preliminary Design of JML: A Behavioral Interface Specification Language for Java. ACM SIGSOFT Software Engineering Notes, 31(3):1-38, March 2006. http://doi.acm.org/10.1145/1127878.1127884. [PDF]
  Also Iowa State University, Department of Computer Science, TR #98-06-rev29, revised January 2006.
• Gary T. Leavens, Erik Poll, Curtis Clifton, Yoonsik Cheon, Clyde Ruby, David Cok, Peter Müller, Joseph Kiniry, Patrice Chalin, and Daniel M. Zimmerman. JML Reference Manual (DRAFT), May 2008. This document contains the collected grammar for JML.

Samples

The samples directory contains many different samples of JML specifications, including samples used in the other documents.

The samples directory contains many different samples of JML specifications, including samples used in the other documents. (See also the package documentation for more examples of JML specifications.) The following describes the individual samples in the release.

• The org.jmlspecs.samples.dbc package and its source directory.
• The org.jmlspecs.samples.digraph package and its source directory.
• The org.jmlspecs.samples.dirobserver package and its source directory.
• The org.jmlspecs.samples.jmlkluwer package and its source directory.
• The org.jmlspecs.samples.jmlrefman package and its source directory.
• The org.jmlspecs.samples.jmltutorial package and its source directory.
• The org.jmlspecs.samples.list package and its source directory.
• The org.jmlspecs.samples.list.iterator package and its source directory.
• The org.jmlspecs.samples.list.list1 package and its source directory.
• The org.jmlspecs.samples.list.list2 package and its source directory.
• The org.jmlspecs.samples.list.list3 package and its source directory.
• The org.jmlspecs.samples.list.node package and its source directory.
• The org.jmlspecs.samples.list.node2 package and its source directory.
• The org.jmlspecs.samples.misc package and its source directory.
• The org.jmlspecs.samples.prelimdesign package and its source directory.
• The org.jmlspecs.samples.reader package and its source directory.
• The org.jmlspecs.samples.sets package and its source directory.
• The org.jmlspecs.samples.stacks package and its source directory.
• The org.jmlspecs.samples.table package and its source directory.

Package documentation

The release contains much jmldoc-produced documentation that can also be seen as examples of JML specifications. Aside from the samples above, this includes the following package documentation.

JML-specific packages

• The org.jmlspecs.lang package and its source directory.
• The org.jmlspecs.models package and its source directory.
• The org.jmlspecs.models.resolve package and its source directory.
• The org.jmlspecs.jmlunit.strategies package and its source directory.
• The org.jmlspecs.jmlrac.runtime package (whose source directory is not included in the release). This package includes the method JMLChecker.setLevel(int), which can be used to control the assertion checking level at runtime.
• The org.jmlspecs.jmlunit package (whose source directory is not included in the release). This includes the class JMLTestRunner.

Java-specific packages

• The java.awt.event package and its source directory.
• The java.io package and its source directory.
• The java.lang package and its source directory.
• The java.lang.reflect package and its source directory.
• The java.math package and its source directory.
• The java.net package and its source directory.
• The java.security package and its source directory.
• The java.sql package and its source directory.
• The java.util package and its source directory.
• The java.util.regex package and its source directory.

Tool documentation

The release contains unix-style manual pages for each of its tools. These have some information on how to use each tool, and specify their options and arguments.

• jml-launcher (the launcher for the graphical user interface tools).
• jml and jml-gui (the checker).
• jmlc and jmlc-gui (compile for runtime assertion checking).
• jmldoc and jmldoc-gui (a version of javadoc that includes JML specification information).
• jmle (compile for executing or prototyping specifications).
• jmlrac (a version of java, the VM, that includes the bin/jmlruntime.jar file in the CLASSPATH, for running files compiled with jmlc).
• jmlre (a version of java, the VM, that includes the runtime support needed for executing specifications, for running files compiled with jmle).
• jmlspec and jmlspec-gui (generate skeleton specification files from Java source files).
• jmlunit and jmlunit-gui (produce unit testing code stubs for use with JUnit).
• jtest (combines the work of jmlc and jmlunit)
• jml-junit (a version of JUnit's swing user interface that includes the bin/jmlruntime.jar and bin/jmljunitruntime.jar files in the CLASSPATH, for running JML and JUnit based tests on files compiled with jmlc and test cases generated by jmlunit).

Information for implementers of JML

If you are developing JML from source code, you may find the following additional links helpful. Most of this is not relevant for most users of JML.

• Tips for developers of the JML tools.
• Documentation for JML's implementation (which is unavailable unless you use make jmldocs to build it from sources).

Non-Local documentation

The following information is accessible via the internet.

• The JML web page.
• SourceForge project page for JML.

Getting help with JML

Questions and Bug Reports

If you have a question that isn't answered in the documentation, or a bug report, please use the SourceForge tracking interface for the jmlspecs project. This is the place to file bug reports, make a support request, submit patches, and submit feature requests for JML and its tools. Note that you have to obtain a (free) SourceForge login to file one of these requests, but this is mostly to help us get back to you.

Since our resources for giving help are limited, please consult the SourceForge trackers to see if we already know of the problem before filing a bug report, and please read the documentation before filing a support request. However, don't be shy if things are not working or if you need help. We really value getting this kind of feedback.

General Comments and Discussions

General comments and discussions about JML can be directed to the jmlspecs-interest mailing list. To subscribe, go to the SourceForge web interface for the jmlspecs-interest mailing list. After you are subscribed, you can post messages by sending mail to jmlspecs-interest@lists.sourceforge.net.

2. Acknowledgments

See the documents or the JML web site for various funding acknowledgements.

The JML checker uses the ANTLR parser-generator from the Magelang Institute.

The development of JML is hosted on sourceforge.net.

See the preliminary design document for more acknowledgments to all the people who have contributed thought and effort into JML.

Last update of this file $Date: 2008/05/20 22:17:41 $

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.