org.eclipse.mtj.core.importer
Class JavadocDetector.GenericLocalFSSearch

java.lang.Object
  org.eclipse.mtj.core.importer.JavadocDetector.GenericLocalFSSearch

All Implemented Interfaces:

JavadocDetector.IJavadocSearchStrategy

Enclosing class:

JavadocDetector

public static class JavadocDetector.GenericLocalFSSearch
extends Object
implements JavadocDetector.IJavadocSearchStrategy

a generic javadoc search strategy, it search the library's javadoc on the local file system,

Field Summary

static int	DEFAULTSEARCHDEPTH
static String[]	PROFILEJAVADOCDIRECTORIES

Constructor Summary

JavadocDetector.GenericLocalFSSearch()

JavadocDetector.GenericLocalFSSearch(String docRootDirectoryPath)

JavadocDetector.GenericLocalFSSearch(String[] docrootDirectoryPaths)

Method Summary

File[]	getDefaultDocRootDirectories(ILibrary library)
File[]	getDocRootDirectories(ILibrary library)
URL	searchForJavaDoc(ILibrary library) search from the directory which name contains "doc" and in the "doc" directory, recursively search the subdirectory whose name is similar to the library's name.

Methods inherited from class java.lang.Object

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

Field Detail

PROFILEJAVADOCDIRECTORIES

public static final String[] PROFILEJAVADOCDIRECTORIES

DEFAULTSEARCHDEPTH

public static final int DEFAULTSEARCHDEPTH

See Also:

Constant Field Values

Constructor Detail

JavadocDetector.GenericLocalFSSearch

public JavadocDetector.GenericLocalFSSearch()

JavadocDetector.GenericLocalFSSearch

public JavadocDetector.GenericLocalFSSearch(String docRootDirectoryPath)

JavadocDetector.GenericLocalFSSearch

public JavadocDetector.GenericLocalFSSearch(String[] docrootDirectoryPaths)

Method Detail

searchForJavaDoc

public URL searchForJavaDoc(ILibrary library)

search from the directory which name contains "doc" and in the "doc" directory, recursively search the subdirectory whose name is similar to the library's name.

Specified by:

searchForJavaDoc in interface JavadocDetector.IJavadocSearchStrategy

Returns:

getDocRootDirectories

public File[] getDocRootDirectories(ILibrary library)

Parameters:

library -

Returns:

the SDK's javadoc root directory

getDefaultDocRootDirectories

public File[] getDefaultDocRootDirectories(ILibrary library)