APIdia Launch Partner
Top Description Inners Fields Constructors Methods
jdk.internal.shellsupport.doc

public abstract Class JavadocHelper

extends Object
implements AutoCloseable
Class Inheritance
All Implemented Interfaces
java.lang.AutoCloseable
Known Direct Subclasses
jdk.internal.shellsupport.doc.JavadocHelper.OnDemandJavadocHelper
Imports
java.io.IOException, java.net.URI, .URISyntaxException, java.nio.file.Path, java.util.ArrayList, .Arrays, .Collection, .Comparator, .HashMap, .HashSet, .IdentityHashMap, .Iterator, .List, .Map, .Map.Entry, .Objects, .Set, .Stack, .TreeMap, java.util.regex.Pattern, java.util.stream.Collectors, .Stream, .StreamSupport, javax.lang.model.element.Element, .ElementKind, .ExecutableElement, .ModuleElement, .TypeElement, .VariableElement, javax.lang.model.type.DeclaredType, .TypeKind, .TypeMirror, javax.lang.model.util.ElementFilter, .Elements, .Elements.DocCommentKind, javax.tools.ForwardingJavaFileManager, .JavaCompiler, .JavaFileManager, .JavaFileObject, .JavaFileObject.Kind, .SimpleJavaFileObject, .StandardJavaFileManager, .StandardLocation, .ToolProvider, com.sun.source.doctree.DocCommentTree, .DocTree, .InheritDocTree, .LinkTree, .ParamTree, .RawTextTree, .ReturnTree, .ThrowsTree, com.sun.source.tree.ClassTree, .CompilationUnitTree, .MethodTree, .Tree, .VariableTree, com.sun.source.util.DocSourcePositions, .DocTreePath, .DocTreeScanner, .DocTrees, .JavacTask, .TreePath, .TreePathScanner, .Trees, com.sun.tools.javac.api.JavacTaskImpl, com.sun.tools.javac.util.Assert, .DefinedBy, .DefinedBy.Api, .Pair, jdk.internal.org.commonmark.ext.gfm.tables.TablesExtension, jdk.internal.org.commonmark.node.Node, jdk.internal.org.commonmark.parser.IncludeSourceSpans, .Parser, jdk.internal.org.commonmark.renderer.html.HtmlRenderer
Helper to find javadoc and resolve @inheritDoc.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
JavadocHelper.OnDemandJavadocHelper

public static record
JavadocHelper.StoredElement

Field Summary

Modifier and TypeField and Description
private static final JavaCompiler
compiler

Constructor Summary

AccessConstructor and Description
public
JavadocHelper()

Method Summary

Modifier and TypeMethod and Description
public abstract void
close()

Redeclares java.lang.AutoCloseable.close.

Closes the helper.

public static JavadocHelper

Returns:

a JavadocHelper
create(JavacTask
JavacTask from which the further Elements originate
mainTask, Collection<? extends Path>
paths where source files should be searched
sourceLocations)

Create the helper.

public abstract JavadocHelper.StoredElement
getHandle(Element forElement)

public abstract String

Returns:

javadoc if found, null otherwise
getResolvedDocComment(Element
element for which the javadoc should be searched
forElement)

Returns javadoc for the given element, if it can be found, or null otherwise.

public abstract String
getResolvedDocComment(JavadocHelper.StoredElement forElement)

public abstract Element

Returns:

source element if found, the original element otherwise
getSourceElement(Element
element for which the source element should be searched
forElement)

Returns an element representing the same given program element, but the returned element will be resolved from source, if it can be found.

public abstract Collection<? extends Path>
getSourceLocations()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait