com.screenscraper.view.languagesupport.javadoc

Class JavaDocLoader

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.JavaDocLoader

public final class JavaDocLoader
extends java.lang.Object

Doc Loader that tries to load javadocs based on a set of criteria

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
JavaDocLoader(java.util.Collection<java.io.File> documentationRootDirectories) Creates a new Java Doc Loader with the given directories

Method Summary

Modifier and Type	Method and Description
void	addAdditionalApiUrl(java.lang.String additionalApiUrl) Adds an additional API url we can try to use to get the javadocs for classes
void	addDocumentationDirectory(java.io.File directory) Adds a new directory to be scanned for documentation
ClassDocumentation	getClassDocumentation(java.lang.Class clazz) Returns the documentation for the given class
ClassDocumentation	getClassDocumentationIfPresent(java.lang.Class clazz) Returns the documentation for the given class if it is present, otherwise return the NULL documentation
ConstructorDocumentation	getConstructorDocumentation(java.lang.reflect.Constructor constructor) Gets the documentation for the given constructor
java.util.Set<java.io.File>	getDocumentationDirectories() Returns the directories that are scanned for documentation
VariableDocumentation	getFieldDocumentation(java.lang.reflect.Field field) Gets the documentation for the given field
SimpleTrie<java.lang.String,JavadocParser>	getKnownImports() Returns the KnownImports for the object
java.util.Set<java.lang.Class>	getLoadedClasses() Returns a set of the currently loaded classes
MethodDocumentation	getMethodDocumentation(java.lang.reflect.Method method) Gets the documentation for the given method
void	preloadClass(java.lang.Class clazz) Preload (and store permanently) the documentation for the specified class
void	purgeAll() Purges all documentation from the cache.
void	purgeCache() Purges all documentation from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocLoader

public JavaDocLoader(@NotNull
                     java.util.Collection<java.io.File> documentationRootDirectories)

Creates a new Java Doc Loader with the given directories

Parameters:

documentationRootDirectories - The directories where the documentation can be found

Method Detail

addAdditionalApiUrl

public void addAdditionalApiUrl(@NotNull
                                java.lang.String additionalApiUrl)

Adds an additional API url we can try to use to get the javadocs for classes

Parameters:

additionalApiUrl - The api endpoint to add

getKnownImports

@NotNull
public SimpleTrie<java.lang.String,JavadocParser> getKnownImports()

Returns the KnownImports for the object

Returns:

The KnownImports for the object

preloadClass

public void preloadClass(@NotNull
                         java.lang.Class clazz)

Preload (and store permanently) the documentation for the specified class

Parameters:

clazz - The class

getClassDocumentationIfPresent

@NotNull
public ClassDocumentation getClassDocumentationIfPresent(@NotNull
                                                                   java.lang.Class clazz)

Returns the documentation for the given class if it is present, otherwise return the NULL documentation

Parameters:

clazz - The class to get the documentation for

Returns:

The documentation for the given class

getClassDocumentation

@NotNull
public ClassDocumentation getClassDocumentation(@NotNull
                                                          java.lang.Class clazz)

Returns the documentation for the given class

Parameters:

clazz - The class to get the documentation for

Returns:

The documentation for the given class

getMethodDocumentation

@NotNull
public MethodDocumentation getMethodDocumentation(@Nullable
                                                            java.lang.reflect.Method method)

Gets the documentation for the given method

Parameters:

method - The method

Returns:

The documentation for the method

getFieldDocumentation

@NotNull
public VariableDocumentation getFieldDocumentation(@Nullable
                                                             java.lang.reflect.Field field)

Gets the documentation for the given field

Parameters:

field - The field

Returns:

The documentation for the field

getConstructorDocumentation

@NotNull
public ConstructorDocumentation getConstructorDocumentation(@NotNull
                                                                      java.lang.reflect.Constructor constructor)

Gets the documentation for the given constructor

Parameters:

constructor - The constructor

Returns:

The constructor documentation

addDocumentationDirectory

public void addDocumentationDirectory(@NotNull
                                      java.io.File directory)

Adds a new directory to be scanned for documentation

Parameters:

directory - The directory to add

getDocumentationDirectories

@NotNull
public java.util.Set<java.io.File> getDocumentationDirectories()

Returns the directories that are scanned for documentation

Returns:

The directories that are scanned for documentation

getLoadedClasses

@NotNull
public java.util.Set<java.lang.Class> getLoadedClasses()

Returns a set of the currently loaded classes

Returns:

A set of the currently loaded classes

purgeCache

public void purgeCache()

Purges all documentation from the cache. This does not include preloaded data

purgeAll

public void purgeAll()

Purges all documentation from the cache. This includes preloaded data