ICodeBaseEntry (FindBugs ${release.number} API)

Interface ICodeBaseEntry

public interface ICodeBaseEntry

Object representing a resource in a code base.

Author: David Hovemeyer

Method Summary
ClassDescriptor	getClassDescriptor() Return the ClassDescriptor of the class resource accessed by this codebase entry.
ICodeBase	getCodeBase() Get the codebase this codebase entry belongs to.
int	getNumBytes() Get the number of bytes in the resource.
String	getResourceName() Get the name of the resource.
InputStream	openResource() Open an input stream reading from the resource.
void	overrideResourceName(String resourceName) Override the resource name of this codebase entry.

Method Summary

ClassDescriptor

getClassDescriptor()

Return the ClassDescriptor of the class resource accessed by this codebase entry.

ICodeBase

getCodeBase()

Get the codebase this codebase entry belongs to.

int

getNumBytes()

Get the number of bytes in the resource.

String

getResourceName()

Get the name of the resource.

InputStream

openResource()

Open an input stream reading from the resource.

void

overrideResourceName(String resourceName)

Override the resource name of this codebase entry.

Method Detail

getClassDescriptor

Return the ClassDescriptor of the class resource accessed by this codebase entry. Do not call this method unless ClassDescriptor.isClassResource() returns true. This method may require the class data to be loaded in order to determine the class.

Returns: ClassDescriptor of this entry

Throws: CheckedAnalysisException if the codebase entry does not reference a valid classfile IllegalArgumentException if the codebase entry's filename is definitely not a classfile

getCodeBase

Get the codebase this codebase entry belongs to.

Returns: the codebase this codebase entry belongs to

getNumBytes

Get the number of bytes in the resource. Returns <0 if the number of bytes is not known.

Returns: number of bytes in the resource, or <0 if not known.

getResourceName

Get the name of the resource.

Returns: the name of the resource

openResource

Open an input stream reading from the resource.

Returns: InputStream reading from the resource.

Throws: IOException if an error occurs reading from the resource

overrideResourceName

Override the resource name of this codebase entry.

Parameters: resourceName the new resource name