org.checkerframework.framework.stub.AnnotationFileResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

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 you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

Show newest version

package org.checkerframework.framework.stub;

import java.io.IOException;
import java.io.InputStream;

/** Interface for sources of stub data. */
public interface AnnotationFileResource {
    /**
     * Returns a user-friendly description of the resource (e.g. a filesystem path).
     *
     * @return a description of the resource
     */
    String getDescription();

    /** Returns a stream for reading the contents of the resource. */
    InputStream getInputStream() throws IOException;
}