assertions : Java Glossary

go to home page A words local find full screen, hide local find menu Google search web for more information on this topic jump to foot of page translate this page with Babelfish by Roedy Green ©1996-2008 Canadian Mind Products
index page for letter ⇒ punctuation 0-9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z (all)
assertions
You do three types of sanity checking in your computer programs:
  1. to check for expected error conditions.
  2. to verify your code does not contain bugs.
  3. to make sure when your program goes insane, you find out about it as soon as possible before it destroys all traces of what went wrong.
For (1) you typically code explicit checks.

For (2) you use asserts which can be turned off once you are sure the code is solid.

For (3) you trust the run time array subscript out of bounds and null pointer checking.

Design by Contract Learning More
Enabling Links
Coding

Design by Contract

It is important to separate the logic for catching user errors from catching programmer errors. The logic for catching programmer errors can be safely turned off for speed once the program has been well tested.

Bertrand Meyer in Eiffel pioneered the use of structured assertions in a system he called Programming By Contract. These serve both to document the preconditions (require) on parameters coming into a method, and the guaranteed characteristics of the result (ensure). Unfortunately, Java still does not support them. They can be crudely added with the JaWa preprocessor.

Java 1.4.1+ has a feature Sun calls assertions but they are so pathetic they don’t deserve the name. It is as though Sun wanted to claim that Java has assertions without doing any work to implement them and not caring if the final product was actually of any use. If Sun wants to try again, they should look at how Eiffel assertions work.

They are new language feature, not just a new class.

Enabling

The main feature is the ability to turn them on and off at run time. This required a slight modification to the class file format. You use the -ea switch on the java.exe command line to enable or -da to disable assertion checking. To compile, you need the -source 1.4 switch on the javac.exe command line. ClassLoaders can conrol the enabling with ClassLoader.setClassAssertionStatus.

In Eclipse, you enable assertions by using the JDK 1.5 level then click run ⇒ arguments ⇒ VM arguments then enter -ea. There is no checkbox to tick.

Coding

You code them like this:
assert a > b : "a must be bigger than b";
The second expression can be anything you would feed to printLn or it can be left out.

To mark a place in your code you should never get, you can code an assertion that always fails like this:

assert false : "Fell out bottom of loop without finding elt.";

Learning More

Sun’s JDK Technote Guide on Assertions : available:

CMP homejump to top
CMP logo
feedback Please email your feedback for publication, errors, omissions, broken/redirected link reports
and suggestions to improve this page to Roedy Green : feedback email
made with CSS
HTML Checked!
ICRA ratings logo
mindprod.com IP:[65.110.21.43]
Your face IP:[38.103.63.59] The information on this page is for non-military use only.
You are visitor number 12,161. Military use includes use by defence contractors.
You can get a fresh copy of this page from: or possibly from your local J: drive (Java virtual drive/mindprod.com website mirror)
http://mindprod.com/jgloss/assertions.html J:\mindprod\jgloss\assertions.html