org.scijava.search.javadoc

Interface JavadocService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.service.SciJavaService, org.scijava.service.Service, org.scijava.Versioned

All Known Implementing Classes:

DefaultJavadocService

public interface JavadocService
extends org.scijava.service.SciJavaService

Service for mapping packages to Javadoc URLs.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
default String	url(Class<?> c) Gets the URL for the javadoc corresponding to the given class.
String	url(String className) Gets the URL for the javadoc corresponding to the given class.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

url

default String url(Class<?> c)

Gets the URL for the javadoc corresponding to the given class.

Parameters:

c - The class.

Returns:

URL of the class's online javadoc, or null if not found.

url

String url(String className)

Gets the URL for the javadoc corresponding to the given class.

Parameters:

className - Fully qualified name of the class.

Returns:

URL of the class's online javadoc, or null if not found.