JavadocService (SciJava Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SciJavaService, Service, Versioned

All Known Implementing Classes:

DefaultJavadocService
```
public interface JavadocService
extends SciJavaService
```
Service for mapping packages to Javadoc URLs.

Author:

Curtis Rueden

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2022 SciJava. All rights reserved.