blob: d9e4814c468a91568a6a923d38170c012ebf09c3 [file] [log] [blame]
<!DOCTYPE html>
<meta name="generator" content=
"HTML Tidy for Linux (vers 25 March 2009), see">
<title>Checker Framework Tutorial</title>
<link href="webpages/bootstrap/css/bootstrap.css" rel="stylesheet" type=
<script type="text/javascript" src=
<link href="webpages/css/main.css" rel="stylesheet" type="text/css">
<link rel="icon" type="image/png" href=
<div class="top_liner"></div>
<div class="navbar navbar-inverse navbar-fixed-top" style=
"border-bottom: 1px solid #66d;">
<div class="navbar-inner">
<div class="contained">
<ul class="nav">
<li class="heading">Checker Framework:</li>
<li><a href="">Main Site</a></li>
<li><a href=
<li><a href=
Discussion List</a></li>
<li><a href=
<li><a href=
<li class="active"><a href=
</div><img src="" alt="Checker Framework logo">
<div class="page-header short" style=
"border-bottom: 1px solid #EEE; border-top: none;">
<h1>Checker Framework Tutorial</h1>
<div id="introduction">
<div class="page-header short" style="border-top: none;">
<div class="section">
<p>The Checker Framework enhances Java's type system to make it more
powerful and useful. This lets software developers detect and
prevent errors in their Java programs. The Checker Framework
includes compiler plug-ins ("checkers") that find bugs or verify
their absence. It also permits software developers to write their
own compiler plug-ins.</p>
<p>In this tutorial, you will learn to use the Checker Framework to
prevent null pointer exceptions, to prevent SQL injection attacks,
and to improve code quality. In this tutorial, you will learn to use the Checker
Framework from the command line.
The Checker
Framework can also be used with other <a href=
such as Maven or InteliJ IDEA, and you could follow
the command-line version of the tutorial using one of those tools.</p>
<div id="commandlinetutorial">
<div class="page-header short">
<h2>Using the Checker Framework from the command line</h2>
<div class="section">
<li><a href=
Install the Checker Framework</a> and then return to this page.<br/>
As described in the installation instructions,
<a href="">set
the alias
<code>javacheck</code></a> to the Checker Framework compiler.</li>
<li><a href="">Download</a> and unzip the source
files for the tutorial, then enter the <code>src</code> directory:
<code>cd src</code></li>
<li><a href="webpages/get-started-cmd.html">Getting Started</a>, a
simple example use of the Nullness Checker</li>
<li><a href="webpages/user-input-cmd.html">Validating User
Input</a>, an example using the Regex Checker</li>
<li><a href="webpages/security-error-cmd.html">Finding a Security
Error</a>, a complex example using the Tainting Checker</li>
<li><a href="webpages/encryption-checker-cmd.html">Writing an
Encryption Checker</a>, an example of writing your own type
<div id="resources">
<div class="page-header short">
<div class="section">
<li><a href=
The Checker Framework Manual</a></li>
<li><a href="">The Checker Framework
<li>There is also a
A <a href="">Nullness
Checker tutorial</a> by David B&uuml;rgin, last updated in April 2016.
The tutorial doesn't work because the setup instructions are out of
date, but some people find it helpful to read through the steps.</li>
<div class="bottom_liner"></div>
<!-- LocalWords: Plugin plugin VM SDK plugins quals classpath
<!-- LocalWords: NullnessChecker plugin's hg