com.screenscraper.view.languagesupport.javadoc.parsers

Interface JavadocParser

All Known Implementing Classes:

AbstractJavadocParser, Javadoc6Parser, Javadoc7Parser, Javadoc8Parser, Javadoc9Parser

public interface JavadocParser

Class Description

Version:

1.0

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllPossibleClasses() Uses the base urls and returns a list of all classes this parser should be able to load docs for (based on the root allclasses doc file(s))
ClassDocumentation	parseFromFile(java.io.File file) Attempts to download the documentation from the internet and return it
ClassDocumentation	parseFromURL(java.lang.Class clazz, java.io.File cachedDocFileLocalCache) Attempts to download the documentation from the internet and return it
ClassDocumentation	parseHTML(java.lang.String data) Parses the string to a ClassDocumentation object

Method Detail

parseFromURL

@NotNull
ClassDocumentation parseFromURL(@NotNull
                                          java.lang.Class clazz,
                                          @Nullable
                                          java.io.File cachedDocFileLocalCache)
                                   throws java.io.IOException

Attempts to download the documentation from the internet and return it

Parameters:

clazz - The class to get the docs for

cachedDocFileLocalCache - The location in which to store the downloaded file, if we found one that downloaded and parsed successfully. Null means don't cache

Returns:

The documentation, if available, or the NULL documentation if not

Throws:

java.io.IOException - If there is an error reading the URL

parseFromFile

@NotNull
ClassDocumentation parseFromFile(@NotNull
                                           java.io.File file)
                                    throws java.io.IOException

Attempts to download the documentation from the internet and return it

Parameters:

file - The file containing the doc

Returns:

The documentation, if available, or the NULL documentation if not

Throws:

java.io.IOException - If there is an error reading the file

parseHTML

@NotNull
ClassDocumentation parseHTML(java.lang.String data)

Parses the string to a ClassDocumentation object

Parameters:

data - The string to parse

Returns:

The parsed value

Throws:

java.lang.IllegalArgumentException - If the value cannot be parsed

getAllPossibleClasses

@NotNull
java.util.List<java.lang.String> getAllPossibleClasses()

Uses the base urls and returns a list of all classes this parser should be able to load docs for (based on the root allclasses doc file(s))

Returns:

The list of all known classes (as strings) from the root urls for docs