com.screenscraper.view.languagesupport.javadoc.parsers

Class AbstractJavadocParser

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.parsers.AbstractJavadocParser

All Implemented Interfaces:

JavadocParser

Direct Known Subclasses:

Javadoc6Parser, Javadoc7Parser, Javadoc8Parser, Javadoc9Parser

public abstract class AbstractJavadocParser
extends java.lang.Object
implements JavadocParser

Class Description

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractJavadocParser.FirstPassParameter Holder for the first pass over parameters

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	WS_CHARS Use this because some of the white characters aren't regular whitespace
protected static java.lang.String	WS_CHARS_ONE_OR_MORE Use this because some of the white characters aren't regular whitespace
protected static java.lang.String	WS_CHARS_ZERO_OR_MORE Use this because some of the white characters aren't regular whitespace

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJavadocParser(java.lang.String... baseDocURLs)

Method Summary

Modifier and Type	Method and Description
void	addBaseDocURL(java.lang.String baseDocURL) Adds a new documentation base url (it is appended to the current list)
void	clearBaseDocURLs() Clears all base doc urls for the provider
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))
protected abstract java.util.Map<java.lang.String,SimpleTrie<java.lang.String,java.lang.Boolean>>	getAvailableClassesMap() Returns the mapping of URLs to available classes we can document from that url
java.util.List<java.lang.String>	getBaseDocURLs() Returns the BaseDocURLs for the provider (as a copy of the internal list)
protected org.jsoup.nodes.Element	getFirstMatchingChildRecursive(org.jsoup.select.Elements elements, java.lang.String tagName, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String textContent)
protected org.jsoup.nodes.Element	getFirstMatchingSibling(org.jsoup.nodes.Element element, java.lang.String tagName, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String textContent)
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
boolean	removeBaseDocURL(java.lang.String baseDocURL) Removes a documentation base url if present

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.screenscraper.view.languagesupport.javadoc.parsers.JavadocParser

parseHTML

Field Detail

WS_CHARS

protected static final java.lang.String WS_CHARS

Use this because some of the white characters aren't regular whitespace

See Also:

Constant Field Values

WS_CHARS_ZERO_OR_MORE

protected static final java.lang.String WS_CHARS_ZERO_OR_MORE

Use this because some of the white characters aren't regular whitespace

See Also:

Constant Field Values

WS_CHARS_ONE_OR_MORE

protected static final java.lang.String WS_CHARS_ONE_OR_MORE

Use this because some of the white characters aren't regular whitespace

See Also:

Constant Field Values

Constructor Detail

AbstractJavadocParser

protected AbstractJavadocParser(@NotNull
                                java.lang.String... baseDocURLs)

Method Detail

getAvailableClassesMap

protected abstract java.util.Map<java.lang.String,SimpleTrie<java.lang.String,java.lang.Boolean>> getAvailableClassesMap()

Returns the mapping of URLs to available classes we can document from that url

Returns:

The mapping of URLs to available classes we can document from that url

getBaseDocURLs

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

Returns the BaseDocURLs for the provider (as a copy of the internal list)

Returns:

The BaseDocURLs for the provider (as a copy of the internal list)

addBaseDocURL

public void addBaseDocURL(@NotNull
                          java.lang.String baseDocURL)

Adds a new documentation base url (it is appended to the current list)

Parameters:

baseDocURL - The url to add

removeBaseDocURL

public boolean removeBaseDocURL(@NotNull
                                java.lang.String baseDocURL)

Removes a documentation base url if present

Parameters:

baseDocURL - The url to remove

Returns:

True if the url was present, false otherwise

clearBaseDocURLs

public void clearBaseDocURLs()

Clears all base doc urls for the provider

parseFromFile

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

Description copied from interface: JavadocParser

Attempts to download the documentation from the internet and return it

Specified by:

parseFromFile in interface JavadocParser

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

parseFromURL

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

Description copied from interface: JavadocParser

Attempts to download the documentation from the internet and return it

Specified by:

parseFromURL in interface JavadocParser

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

getAllPossibleClasses

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

Description copied from interface: JavadocParser

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))

Specified by:

getAllPossibleClasses in interface JavadocParser

Returns:

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

getFirstMatchingChildRecursive

@Nullable
protected org.jsoup.nodes.Element getFirstMatchingChildRecursive(@NotNull
                                                                            org.jsoup.select.Elements elements,
                                                                            @Nullable
                                                                            java.lang.String tagName,
                                                                            @Nullable
                                                                            java.lang.String attributeName,
                                                                            @Nullable
                                                                            java.lang.String attributeValue,
                                                                            @Nullable
                                                                            java.lang.String textContent)

getFirstMatchingSibling

@Nullable
protected org.jsoup.nodes.Element getFirstMatchingSibling(@Nullable
                                                                     org.jsoup.nodes.Element element,
                                                                     @Nullable
                                                                     java.lang.String tagName,
                                                                     @Nullable
                                                                     java.lang.String attributeName,
                                                                     @Nullable
                                                                     java.lang.String attributeValue,
                                                                     @Nullable
                                                                     java.lang.String textContent)