org.checkerframework.framework.stub.JarEntryAnnotationFileResource 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;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/** {@link JarEntry}-based implementation of {@link AnnotationFileResource}. */
public class JarEntryAnnotationFileResource implements AnnotationFileResource {
    /** The underlying JarFile. */
    private final JarFile file;

    /** The entry in the jar file. */
    private final JarEntry entry;

    /**
     * Constructs a {@code AnnotationFileResource} for the specified entry in the specified JAR
     * file.
     *
     * @param file the JAR file
     * @param entry the JAR entry
     */
    public JarEntryAnnotationFileResource(JarFile file, JarEntry entry) {
        this.file = file;
        this.entry = entry;
    }

    @Override
    public String getDescription() {
        return file.getName() + "!" + entry.getName();
    }

    @Override
    public InputStream getInputStream() throws IOException {
        return file.getInputStream(entry);
    }
}