edu.umd.cs.findbugs.classfile.impl
Class DirectoryCodeBase

java.lang.Object
  edu.umd.cs.findbugs.classfile.impl.AbstractScannableCodeBase
      edu.umd.cs.findbugs.classfile.impl.DirectoryCodeBase

All Implemented Interfaces:

ICodeBase, IScannableCodeBase

public class DirectoryCodeBase
extends AbstractScannableCodeBase

IScannableCodeBase implementation to read resources from a filesystem directory.

Author:

David Hovemeyer

Field Summary

Fields inherited from interface edu.umd.cs.findbugs.classfile.ICodeBase

IN_JAR_MANIFEST, IN_SYSTEM_CLASSPATH, NESTED, SPECIFIED

Constructor Summary

DirectoryCodeBase(ICodeBaseLocator codeBaseLocator, java.io.File directory)
Constructor.

Method Summary

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

Methods inherited from class edu.umd.cs.findbugs.classfile.impl.AbstractScannableCodeBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryCodeBase

public DirectoryCodeBase(ICodeBaseLocator codeBaseLocator,
                         java.io.File directory)

Constructor.

Parameters:

codeBaseLocator - the codebase locator for this codebase

directory - the filesystem directory

Method Detail

iterator

public ICodeBaseIterator iterator()
                           throws java.lang.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:

java.lang.InterruptedException

getPathName

public java.lang.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.

lookupResource

public ICodeBaseEntry lookupResource(java.lang.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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object