Package org.apache.maven.tools.plugin.javadoc

Class JavadocSite

java.lang.Object

org.apache.maven.tools.plugin.javadoc.JavadocSite

class JavadocSite
extends Object

Allows to create links to a site generated by javadoc (incl. deep-linking). The site may be either accessible (online) or non-accessible (offline) when using this class.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final URI	baseUri
(package private) final Map<String,String>	containedPackageNamesAndModules
static final int	DEFAULT_TIMEOUT	The default timeout used when fetching url, i.e.
private static final String	PREFIX_MODULE
(package private) final boolean	requireModuleNameInPath
(package private) final org.apache.maven.settings.Settings	settings
(package private) JavadocLinkGenerator.JavadocToolVersionRange	version
(package private) static final EnumMap<FullyQualifiedJavadocReference.MemberType,EnumSet<JavadocLinkGenerator.JavadocToolVersionRange>>	VERSIONS_PER_TYPE

Constructor Summary

Constructors

Constructor	Description
JavadocSite(URI url, org.apache.maven.settings.Settings settings)	Constructor for online sites having an accessible package-list or element-list.
JavadocSite(URI url, JavadocLinkGenerator.JavadocToolVersionRange version, boolean requireModuleNameInPath)	Constructor for offline sites.

Method Summary

Modifier and Type	Method	Description
(package private) URI	appendMemberAsFragment(URI url, Optional<String> optionalMember, Optional<FullyQualifiedJavadocReference.MemberType> optionalMemberType)
(package private) URI	appendMemberAsFragment(URI url, FullyQualifiedJavadocReference reference)
private static org.apache.http.impl.client.CloseableHttpClient	createHttpClient(org.apache.maven.settings.Settings settings, URL url)	Creates a new HttpClient instance.
URI	createLink(String packageName, String className)	Generates a link to a javadoc html page below the javadoc site represented by this object.
(package private) static URI	createLink(URI baseUri, Optional<String> moduleName, Optional<String> packageName, Optional<String> className)
URI	createLink(FullyQualifiedJavadocReference javadocReference)	Generates a link to a javadoc html page below the javadoc site represented by this object.
(package private) static URI	createLink(FullyQualifiedJavadocReference javadocReference, URI baseUri, BiFunction<URI,FullyQualifiedJavadocReference,URI> fragmentAppender)
(package private) static URI	createLink(FullyQualifiedJavadocReference javadocReference, URI baseUri, BiFunction<URI,FullyQualifiedJavadocReference,URI> fragmentAppender, Optional<String> pathPrefix)
(package private) boolean	findAnchor(URI uri, String anchorNameOrId)
(package private) static boolean	findLineContaining(URI url, org.apache.maven.settings.Settings settings, Pattern pattern)
(package private) static Pattern	getAnchorPattern(String anchorNameOrId)
URI	getBaseUri()
(package private) static String	getFragmentForMember(JavadocLinkGenerator.JavadocToolVersionRange version, String member, boolean isConstructor)	canonical format given by member is using parentheses and comma.
(package private) static Map.Entry<String,String>	getPackageAndClassName(String binaryName)	Splits up a given binary class name into package name and simple class name part.
(package private) static Map<String,String>	getPackageListWithModules(URI url, org.apache.maven.settings.Settings settings)
(package private) static BufferedReader	getReader(URL url, org.apache.maven.settings.Settings settings)
boolean	hasEntryFor(Optional<String> moduleName, Optional<String> packageName)
static boolean	isNotEmpty(Collection<?> collection)	Convenience method to determine that a collection is not empty or null.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX_MODULE

private static final String PREFIX_MODULE

See Also:

• Constant Field Values

baseUri

final URI baseUri

settings

final org.apache.maven.settings.Settings settings

containedPackageNamesAndModules

final Map<String,String> containedPackageNamesAndModules

requireModuleNameInPath

final boolean requireModuleNameInPath

VERSIONS_PER_TYPE

static final EnumMap<FullyQualifiedJavadocReference.MemberType,EnumSet<JavadocLinkGenerator.JavadocToolVersionRange>> VERSIONS_PER_TYPE

version

JavadocLinkGenerator.JavadocToolVersionRange version

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

The default timeout used when fetching url, i.e. 2000.

See Also:

• Constant Field Values

Constructor Details

JavadocSite

JavadocSite(URI url,
 org.apache.maven.settings.Settings settings)
     throws IOException

Constructor for online sites having an accessible package-list or element-list.

Parameters:

url -

settings -

Throws:

IOException

JavadocSite

JavadocSite(URI url,
 JavadocLinkGenerator.JavadocToolVersionRange version,
 boolean requireModuleNameInPath)

Constructor for offline sites. This throws UnsupportedOperationException for hasEntryFor(Optional, Optional).

Method Details

getPackageListWithModules

static Map<String,String> getPackageListWithModules(URI url,
 org.apache.maven.settings.Settings settings)
                                             throws IOException

Throws:

IOException

findLineContaining

static boolean findLineContaining(URI url,
 org.apache.maven.settings.Settings settings,
 Pattern pattern)
                           throws IOException

Throws:

IOException

getBaseUri

public URI getBaseUri()

hasEntryFor

public boolean hasEntryFor(Optional<String> moduleName,
 Optional<String> packageName)

createLink

public URI createLink(String packageName,
 String className)

Generates a link to a javadoc html page below the javadoc site represented by this object. The link is not validated (i.e. might point to a non-existing page)

Returns:

the (deep-)link towards a javadoc page

Throws:

IllegalArgumentException - if no link can be created

getPackageAndClassName

static Map.Entry<String,String> getPackageAndClassName(String binaryName)

Splits up a given binary class name into package name and simple class name part.

Parameters:

binaryName - a binary name according to JLS 13.1

Returns:

a key value pair where the key is the package name and the value the class name

Throws:

IllegalArgumentException - if no link can be created

createLink

public URI createLink(FullyQualifiedJavadocReference javadocReference)
               throws IllegalArgumentException

Generates a link to a javadoc html page below the javadoc site represented by this object. The link is not validated (i.e. might point to a non-existing page)

Parameters:

javadocReference - a code reference from a javadoc tag

Returns:

the (deep-)link towards a javadoc page

Throws:

IllegalArgumentException - if no link can be created

createLink

static URI createLink(FullyQualifiedJavadocReference javadocReference,
 URI baseUri,
 BiFunction<URI,FullyQualifiedJavadocReference,URI> fragmentAppender)

createLink

static URI createLink(FullyQualifiedJavadocReference javadocReference,
 URI baseUri,
 BiFunction<URI,FullyQualifiedJavadocReference,URI> fragmentAppender,
 Optional<String> pathPrefix)
               throws IllegalArgumentException

Throws:

IllegalArgumentException

createLink

static URI createLink(URI baseUri,
 Optional<String> moduleName,
 Optional<String> packageName,
 Optional<String> className)
               throws URISyntaxException

Throws:

URISyntaxException

appendMemberAsFragment

URI appendMemberAsFragment(URI url,
 FullyQualifiedJavadocReference reference)

appendMemberAsFragment

URI appendMemberAsFragment(URI url,
 Optional<String> optionalMember,
 Optional<FullyQualifiedJavadocReference.MemberType> optionalMemberType)
                    throws URISyntaxException,
IOException

Parameters:

url -

optionalMember -

optionalMemberType -

Returns:

Throws:

URISyntaxException

IOException

See Also:

• Name generation in Javadoc8
• Javadoc Tools Source since JDK10
• Javadoc Tools Source JDK9
• Javadoc Tools Source JDK8

getFragmentForMember

static String getFragmentForMember(JavadocLinkGenerator.JavadocToolVersionRange version,
 String member,
 boolean isConstructor)

canonical format given by member is using parentheses and comma.

Parameters:

version -

member -

isConstructor -

Returns:

the anchor

findAnchor

boolean findAnchor(URI uri,
 String anchorNameOrId)
            throws MalformedURLException,
IOException

Throws:

MalformedURLException

IOException

getAnchorPattern

static Pattern getAnchorPattern(String anchorNameOrId)

createHttpClient

private static org.apache.http.impl.client.CloseableHttpClient createHttpClient(org.apache.maven.settings.Settings settings,
 URL url)

Creates a new HttpClient instance.

Parameters:

settings - The settings to use for setting up the client or null.

url - The URL to use for setting up the client or null.

Returns:

A new HttpClient instance.

Since:

2.8

See Also:

• DEFAULT_TIMEOUT

getReader

static BufferedReader getReader(URL url,
 org.apache.maven.settings.Settings settings)
                         throws IOException

Throws:

IOException

isNotEmpty

public static boolean isNotEmpty(Collection<?> collection)

Convenience method to determine that a collection is not empty or null.

Parameters:

collection - the collection to verify

Returns:

true if not null and not empty, otherwise false