org.checkerframework.framework.stub

Class StubGenerator

java.lang.Object

org.checkerframework.framework.stub.StubGenerator

public class StubGenerator
extends Object

Generates a stub file from a single class or an entire package.

A stub file can be used to add annotations to methods of classes, that are only available in binary or the source of which cannot be edited.

See the Checker Framework Manual:

Using stub classes

Constructor Summary

Constructors

Constructor and Description
StubGenerator() Constructs a StubGenerator that outputs to System.out.
StubGenerator(OutputStream out) Constructs a StubGenerator that outputs to the provided output stream.
StubGenerator(PrintStream out) Constructs a StubGenerator that outputs to the provided output stream.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) The main entry point to StubGenerator.
void	stubFromField(Element elt) Generate the stub file for all the classes within the provided package.
void	stubFromMethod(Element elt) Generate the stub file for all the classes within the provided package.
void	stubFromPackage(PackageElement packageElement) Generate the stub file for all the classes within the provided package.
void	stubFromType(TypeElement typeElement) Generate the stub file for provided class.

Methods inherited from class java.lang.Object

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

Constructor Detail

StubGenerator

public StubGenerator()

Constructs a StubGenerator that outputs to System.out.

StubGenerator

public StubGenerator(PrintStream out)

Constructs a StubGenerator that outputs to the provided output stream.

Parameters:

out - the output stream

StubGenerator

public StubGenerator(OutputStream out)

Constructs a StubGenerator that outputs to the provided output stream.

Parameters:

out - the output stream

Method Detail

stubFromField

public void stubFromField(Element elt)

Generate the stub file for all the classes within the provided package.

stubFromPackage

public void stubFromPackage(PackageElement packageElement)

Generate the stub file for all the classes within the provided package.

stubFromMethod

public void stubFromMethod(Element elt)

Generate the stub file for all the classes within the provided package.

stubFromType

public void stubFromType(TypeElement typeElement)

Generate the stub file for provided class. The generated file includes the package name.

main

public static void main(String[] args)

The main entry point to StubGenerator.

Parameters:

args - command-line arguments