org.checkerframework.gradle.plugin

Class CheckerFrameworkPluginExtension

java.lang.Object

org.checkerframework.gradle.plugin.CheckerFrameworkPluginExtension

public class CheckerFrameworkPluginExtension
extends java.lang.Object

An Extension is a way to define a DSL for a plugin. The Checker Framework's DSL allows users to specify, in their build script, things like which checkers to run and what additional options to pass to the typechecker.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TASK_EXTENSION_NAME

Constructor Summary

Constructors

Constructor and Description
CheckerFrameworkPluginExtension(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
void	addChecker(java.lang.String newChecker) Add a new typechecker to the list of checkers that should be executed.
void	addTask(java.lang.String taskName) Adds a task to the list of tasks that the Checker Framework will be executed as part of.
<T extends org.gradle.api.tasks.compile.JavaCompile> void	applyTo(T task) Applies the Checker Framework to the given task.
<T extends org.gradle.api.tasks.compile.JavaCompile> void	applyTo(org.gradle.api.tasks.TaskCollection<T> tasks) Applies the Checker Framework to all of the given tasks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TASK_EXTENSION_NAME

public static final java.lang.String TASK_EXTENSION_NAME

See Also:

Constant Field Values

Constructor Detail

CheckerFrameworkPluginExtension

public CheckerFrameworkPluginExtension(org.gradle.api.Project project)

Method Detail

addTask

public void addTask(java.lang.String taskName)

Adds a task to the list of tasks that the Checker Framework will be executed as part of. If this list is empty when the Checker Framework is executed, the plugin will automatically apply the CF to either: - the compileJava task, if the project uses the 'java' or 'java-library' plugins, or - the compileDebugJava task, if the project uses the 'com.android.application' plugin You can call this method repeatedly to add multiple tasks.

Parameters:

taskName - the name of the task to modify

addChecker

public void addChecker(java.lang.String newChecker)

Add a new typechecker to the list of checkers that should be executed. You can call this method repeatedly to add multiple typecheckers.

Parameters:

newChecker - the fully-qualified name of the new typechecker, e.g. "org.checkerframework.checker.index.IndexChecker".

applyTo

public <T extends org.gradle.api.tasks.compile.JavaCompile> void applyTo(T task)

Applies the Checker Framework to the given task. Configuration options will be provided on a task extension named 'checkerframework'. The CF will be run as an agent during the execution of the task.

Parameters:

task - the task to apply the CF to.

See Also:

TASK_EXTENSION_NAME

applyTo

public <T extends org.gradle.api.tasks.compile.JavaCompile> void applyTo(org.gradle.api.tasks.TaskCollection<T> tasks)

Applies the Checker Framework to all of the given tasks.

Parameters:

tasks - the tasks to apply the CF to