/*
* FindBugs - Find Bugs in Java programs
* Copyright (C) 2006-2007 University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs.classfile.engine;
import java.io.IOException;
import java.io.InputStream;
import edu.umd.cs.findbugs.classfile.CheckedAnalysisException;
import edu.umd.cs.findbugs.classfile.ClassDescriptor;
import edu.umd.cs.findbugs.classfile.IAnalysisCache;
import edu.umd.cs.findbugs.classfile.ICodeBase;
import edu.umd.cs.findbugs.classfile.ICodeBaseEntry;
import edu.umd.cs.findbugs.classfile.MissingClassException;
import edu.umd.cs.findbugs.classfile.RecomputableClassAnalysisEngine;
import edu.umd.cs.findbugs.classfile.ResourceNotFoundException;
import edu.umd.cs.findbugs.classfile.analysis.ClassData;
import edu.umd.cs.findbugs.classfile.impl.ZipInputStreamCodeBaseEntry;
import edu.umd.cs.findbugs.io.IO;
/**
* Analysis engine to produce the data (bytes) of a class.
*
* @author David Hovemeyer
*/
public class ClassDataAnalysisEngine extends RecomputableClassAnalysisEngine<ClassData> {
@Override
public ClassData analyze(IAnalysisCache analysisCache, ClassDescriptor descriptor) throws CheckedAnalysisException {
// Compute the resource name
String resourceName = descriptor.toResourceName();
// Look up the codebase entry for the resource
ICodeBaseEntry codeBaseEntry;
try {
codeBaseEntry = analysisCache.getClassPath().lookupResource(resourceName);
} catch (ResourceNotFoundException e) {
// Allow loading javax.annotation's from our own classpath - in case we analyze projects
// using 3rd party nullness annotations (which do not have jsr305 classes on classpath)
if(resourceName.startsWith("javax/annotation/")){
codeBaseEntry = new VirtualCodeBaseEntry(descriptor);
} else {
throw new MissingClassException(descriptor, e);
}
}
byte[] data;
if (codeBaseEntry instanceof ZipInputStreamCodeBaseEntry) {
data = ((ZipInputStreamCodeBaseEntry) codeBaseEntry).getBytes();
} else {
try {
// Create a ByteArrayOutputStream to capture the class data
int length = codeBaseEntry.getNumBytes();
InputStream in = codeBaseEntry.openResource();
if (length >= 0) {
data = IO.readAll(in, length);
} else {
data = IO.readAll(in);
}
} catch (IOException e) {
throw new MissingClassException(descriptor, e);
}
}
return new ClassData(descriptor, codeBaseEntry, data);
}
@Override
public void registerWith(IAnalysisCache analysisCache) {
analysisCache.registerClassAnalysisEngine(ClassData.class, this);
}
private static class VirtualCodeBaseEntry implements ICodeBaseEntry {
private final ClassDescriptor descriptor;
public VirtualCodeBaseEntry(ClassDescriptor descriptor) {
this.descriptor = descriptor;
}
@Override
public String getResourceName() {
return descriptor.toResourceName();
}
@Override
public int getNumBytes() {
return -1;
}
@Override
public InputStream openResource() throws IOException {
InputStream stream = getClass().getClassLoader().getResourceAsStream(descriptor.toResourceName());
if(stream == null){
throw new IOException("Can not load '" + descriptor.toResourceName() + "' from FindBugs classpath.");
}
return stream;
}
@Override
public ICodeBase getCodeBase() {
return null;
}
@Override
public ClassDescriptor getClassDescriptor() {
return descriptor;
}
@Override
public void overrideResourceName(String resourceName) {
//
}
}
}