Eclipse Java Compiler extension to insert runtime non-null assertions
Java Perl
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
org.eclipselabs.nullness.buckminster
org.eclipselabs.nullness.feature
org.eclipselabs.nullness.site
org.eclipselabs.nullness.tests.jdtdisabled
org.eclipselabs.nullness.tests.jdtenabled
org.eclipselabs.nullness.ui
org.eclipselabs.nullness
.gitignore
README.md

README.md

Runtime non-null assertions with Eclipse

This is a small compile participant that inserts runtime non-null checks for parameters and methods that are annotated with @NonNull annotations. It is not bound to a limited set of annotations but harmonizes among different specifications with different APIs instead. The compiler extension works for javax.annotations, the Eclipse JDT nullness annotations and others.

This feature was inspired by the equivalent functionality in IntelliJ IDEA, where the "compiler can be configured to track @NotNull annotation compliance during the application runtime."

What does it do?

The compiler that inserts the runtime assertions does not depend on JDTs static annotation processing. In fact it is significantly different from that (and thereby works like a complementary addition): Nullness annotations are considered to be part of the contract that a class defines. If you inherit from an annotated class, it should not be necessary to re-specify all its constraints again. In fact the code that is written should be checked against the inherited specification albeit the repeated annotations. That is the value what this project does. All the inherited nullness constraints are taken into account and your code is enhanced at compile time by non-null checks if appropriate. It's pretty much the equivalent to Java's runtime type checks.

As soon as you implement a non-null method but return null by accident, an exception is thrown at runtime that tells you that something went wrong:

 Non-null method MyType#myMethod must not return null

The same applies for parameters that are specified as non-null. If you pass a null value, an exception is raised with a meaningful message:

 Argument for non-null parameter aParam at index 1 of MyType#myMethod must not be null

Build on cloudbees

Find the artifacts here: Build Status