edu.umd.cs.findbugs.classfile
Interface ICodeBaseLocator

All Known Implementing Classes:

FilesystemCodeBaseLocator, NestedZipFileCodeBaseLocator

public interface ICodeBaseLocator

Specify the location of a codebase.

Author:

David Hovemeyer

Method Summary

ICodeBaseLocator	createRelativeCodeBaseLocator(java.lang.String relativePath) Get the codebase locator describing the location of a relative codebase.
ICodeBase	openCodeBase() Get the codebase object.
java.lang.String	toString() Convert the codebase locator to a string representation.

Method Detail

openCodeBase

ICodeBase openCodeBase()
                       throws java.io.IOException,
                              ResourceNotFoundException

Get the codebase object.

Returns:

the codebase object

Throws:

java.io.IOException

ResourceNotFoundException

createRelativeCodeBaseLocator

ICodeBaseLocator createRelativeCodeBaseLocator(java.lang.String relativePath)

Get the codebase locator describing the location of a relative codebase. This method is useful for getting the location of a codebase referred to in the Class-Path attribute of a Jar manifest.

Parameters:

relativePath - the path of a relative codebase

Returns:

codebase locator of the relative codebase whose path is given

toString

java.lang.String toString()

Convert the codebase locator to a string representation. If possible two codebase locators that refer to the same codebase should produce the same string representation. So, this string can serve as a key identifying the codebase in a map.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the codebase