Class NestedZipFileCodeBase

java.lang.Object

edu.umd.cs.findbugs.classfile.impl.AbstractScannableCodeBase

edu.umd.cs.findbugs.classfile.impl.NestedZipFileCodeBase

All Implemented Interfaces:

ICodeBase, IScannableCodeBase, AutoCloseable

public class NestedZipFileCodeBase
extends AbstractScannableCodeBase

A scannable code base class for a zip (or Jar) file nested inside some other codebase. These are handled by extracting the nested zip/jar file to a temporary file, and delegating to an internal ZipFileCodeBase that reads from the temporary file.

Nested Class Summary

Nested classes/interfaces inherited from interface ICodeBase

ICodeBase.Discovered

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractScannableCodeBase	delegateCodeBase
private final ICodeBase	parentCodeBase
private final String	resourceName
private File	tempFile

Constructor Summary

Constructors

Constructor	Description
NestedZipFileCodeBase(NestedZipFileCodeBaseLocator codeBaseLocator)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	This method should be called when done using the code base.
String	getPathName()	Get the filesystem pathname of this codebase.
ICodeBaseIterator	iterator()	Get an iterator over the resources in the this code base.
ICodeBaseEntry	lookupResource(String resourceName)	Look up a resource in this code base.

Methods inherited from class AbstractScannableCodeBase

addLastModifiedTime, addResourceNameTranslation, containsSourceFiles, getCodeBaseLocator, getHowDiscovered, getLastModifiedTime, isApplicationCodeBase, setApplicationCodeBase, setHowDiscovered, setLastModifiedTime, translateResourceName

Methods inherited from class Object

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

Field Details

parentCodeBase

private final ICodeBase parentCodeBase

resourceName

private final String resourceName

tempFile

private File tempFile

delegateCodeBase

private AbstractScannableCodeBase delegateCodeBase

Constructor Details

NestedZipFileCodeBase

public NestedZipFileCodeBase(NestedZipFileCodeBaseLocator codeBaseLocator)
                      throws ResourceNotFoundException,
IOException

Constructor.

Parameters:

codeBaseLocator - the codebase locator for this codebase

Throws:

ResourceNotFoundException

IOException

Method Details

iterator

public ICodeBaseIterator iterator()
                           throws InterruptedException

Description copied from interface: IScannableCodeBase

Get an iterator over the resources in the this code base.

Returns:

ICodeBaseIterator over the resources in the code base

Throws:

InterruptedException

lookupResource

public ICodeBaseEntry lookupResource(String resourceName)

Description copied from interface: ICodeBase

Look up a resource in this code base.

Parameters:

resourceName - name of the resource to look up

Returns:

ICodeBaseEntry representing the resource or null if the resource cannot be found in this code base

getPathName

public String getPathName()

Description copied from interface: ICodeBase

Get the filesystem pathname of this codebase.

Returns:

the filesystem pathname of this codebase, or null if this codebase is not accessible via the filesystem

close

public void close()

Description copied from interface: ICodeBase

This method should be called when done using the code base.