com.phoenixnap.oss.ramlapisync.javadoc

Class JavaDocExtractor

java.lang.Object

com.phoenixnap.oss.ramlapisync.javadoc.JavaDocExtractor

public class JavaDocExtractor
extends Object

Class containing a class-keyed cache and file search for JavaDoc operations TODO allow user to specify the package structures to search in

Since:

0.0.1

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
protected File	baseDir
protected Map<Class<?>,JavaDocStore>	javaDocCache Cache of JavaDocStores for each class we visit.
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
JavaDocExtractor(File baseDir)

Method Summary

Modifier and Type	Method and Description
JavaDocStore	getJavaDoc(Class<?> clazz) Extracts the Java Doc for a specific class from its Source code as well as any superclasses or implemented interfaces.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

baseDir

protected File baseDir

javaDocCache

protected Map<Class<?>,JavaDocStore> javaDocCache

Cache of JavaDocStores for each class we visit.

Constructor Detail

JavaDocExtractor

public JavaDocExtractor(File baseDir)

Method Detail

getJavaDoc

public JavaDocStore getJavaDoc(Class<?> clazz)

Extracts the Java Doc for a specific class from its Source code as well as any superclasses or implemented interfaces.

Parameters:

clazz - The Class for which to get javadoc

Returns:

A parsed documentation store with the class's Javadoc or empty if none is found.