B C E F G H I J L M N O P R S T U V

B

BaseJavadoc - Class in com.github.therapi.runtimejavadoc

BlockTag - Class in com.github.therapi.runtimejavadoc.internal.parser

BlockTag(String, String) - Constructor for class com.github.therapi.runtimejavadoc.internal.parser.BlockTag

buf - Variable in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

build() - Method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

build() - Method in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

C

ClassJavadoc - Class in com.github.therapi.runtimejavadoc

ClassJavadoc(String, Comment, List<FieldJavadoc>, List<FieldJavadoc>, List<MethodJavadoc>, List<MethodJavadoc>, List<OtherJavadoc>, List<SeeAlsoJavadoc>, List<ParamJavadoc>) - Constructor for class com.github.therapi.runtimejavadoc.ClassJavadoc

com.github.therapi.runtimejavadoc - package com.github.therapi.runtimejavadoc

com.github.therapi.runtimejavadoc.internal - package com.github.therapi.runtimejavadoc.internal

com.github.therapi.runtimejavadoc.internal.parser - package com.github.therapi.runtimejavadoc.internal.parser

Comment - Class in com.github.therapi.runtimejavadoc

Comment text that may contain inline tags.

Comment(List<CommentElement>) - Constructor for class com.github.therapi.runtimejavadoc.Comment

CommentElement - Class in com.github.therapi.runtimejavadoc

CommentElement() - Constructor for class com.github.therapi.runtimejavadoc.CommentElement

CommentFormatter - Class in com.github.therapi.runtimejavadoc

Performs basic conversion of a Comment into a String.

CommentFormatter() - Constructor for class com.github.therapi.runtimejavadoc.CommentFormatter

CommentText - Class in com.github.therapi.runtimejavadoc

CommentText(String) - Constructor for class com.github.therapi.runtimejavadoc.CommentText

commentText(String) - Method in interface com.github.therapi.runtimejavadoc.CommentVisitor

commentText(String) - Method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

commentText(String) - Method in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

CommentVisitor - Interface in com.github.therapi.runtimejavadoc

constructorsFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

createEmpty(String) - Static method in class com.github.therapi.runtimejavadoc.ClassJavadoc

createEmpty() - Static method in class com.github.therapi.runtimejavadoc.Comment

createEmpty(String) - Static method in class com.github.therapi.runtimejavadoc.FieldJavadoc

createEmpty(Executable) - Static method in class com.github.therapi.runtimejavadoc.MethodJavadoc

createLinkElement(String, String) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.LinkParser

E

elementDocFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

elementNameFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

enumConstantsFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

equals(Object) - Method in class com.github.therapi.runtimejavadoc.CommentText

equals(Object) - Method in class com.github.therapi.runtimejavadoc.InlineLink

equals(Object) - Method in class com.github.therapi.runtimejavadoc.InlineTag

equals(Object) - Method in class com.github.therapi.runtimejavadoc.InlineValue

equals(Object) - Method in class com.github.therapi.runtimejavadoc.internal.MethodSignature

equals(Object) - Method in class com.github.therapi.runtimejavadoc.Link

equals(Object) - Method in class com.github.therapi.runtimejavadoc.Value

escapeHtml(String) - Static method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

Escapes the HTML special characters: " & < >

F

FieldJavadoc - Class in com.github.therapi.runtimejavadoc

FieldJavadoc(String, Comment, List<OtherJavadoc>, List<SeeAlsoJavadoc>) - Constructor for class com.github.therapi.runtimejavadoc.FieldJavadoc

fieldsFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

findBridgeMethod(Method) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

format(Comment) - Method in class com.github.therapi.runtimejavadoc.CommentFormatter

Render the comment as an HTML String.

from(MethodJavadoc) - Static method in class com.github.therapi.runtimejavadoc.internal.MethodSignature

from(Executable) - Static method in class com.github.therapi.runtimejavadoc.internal.MethodSignature

G

getAllTypeAncestors(Class<?>) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

getComment() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

getComment() - Method in class com.github.therapi.runtimejavadoc.OtherJavadoc

getComment() - Method in class com.github.therapi.runtimejavadoc.ParamJavadoc

getComment() - Method in class com.github.therapi.runtimejavadoc.ThrowsJavadoc

getConstructors() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

getElements() - Method in class com.github.therapi.runtimejavadoc.Comment

Returns the elements this comment consists of.

getEnumConstants() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

getFields() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

getHtmlLink() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

getJavadoc(Class<?>) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given class.

getJavadoc(String) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given class.

getJavadoc(String, ClassLoader) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given class, using the given ClassLoader to find the Javadoc resource.

getJavadoc(String, Class<?>) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given class, using the given Class object to load the Javadoc resource.

getJavadoc(Method) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given method.

getJavadoc(Constructor<?>) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given constructor.

getJavadoc(Field) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given field.

getJavadoc(Enum<?>) - Static method in class com.github.therapi.runtimejavadoc.RuntimeJavadoc

Gets the Javadoc of the given enum constant.

getLabel() - Method in class com.github.therapi.runtimejavadoc.Link

getLink() - Method in class com.github.therapi.runtimejavadoc.InlineLink

getLink() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

getLink() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.HtmlLink

getMethods() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

getName() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

getName() - Method in class com.github.therapi.runtimejavadoc.InlineTag

getName() - Method in class com.github.therapi.runtimejavadoc.OtherJavadoc

Returns the name of the tag (including the "@")

getName() - Method in class com.github.therapi.runtimejavadoc.ParamJavadoc

Returns the name of parameter

getName() - Method in class com.github.therapi.runtimejavadoc.ThrowsJavadoc

getOther() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

getParams() - Method in class com.github.therapi.runtimejavadoc.Link

getParams() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

getParamTypes() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

getRecordComponents() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

If this class is a record, returns the "@param" tags from the canonical constructor.

getReferencedClassName() - Method in class com.github.therapi.runtimejavadoc.Link

getReferencedClassName() - Method in class com.github.therapi.runtimejavadoc.Value

getReferencedMemberName() - Method in class com.github.therapi.runtimejavadoc.Link

getReferencedMemberName() - Method in class com.github.therapi.runtimejavadoc.Value

getReturns() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

getSeeAlso() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

getSeeAlsoType() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

getStringLiteral() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

getText() - Method in class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.HtmlLink

getThrows() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

getValue() - Method in class com.github.therapi.runtimejavadoc.CommentText

getValue() - Method in class com.github.therapi.runtimejavadoc.InlineTag

getValue() - Method in class com.github.therapi.runtimejavadoc.InlineValue

H

hashCode() - Method in class com.github.therapi.runtimejavadoc.CommentText

hashCode() - Method in class com.github.therapi.runtimejavadoc.InlineLink

hashCode() - Method in class com.github.therapi.runtimejavadoc.InlineTag

hashCode() - Method in class com.github.therapi.runtimejavadoc.InlineValue

hashCode() - Method in class com.github.therapi.runtimejavadoc.internal.MethodSignature

hashCode() - Method in class com.github.therapi.runtimejavadoc.Link

hashCode() - Method in class com.github.therapi.runtimejavadoc.Value

HtmlLink(String, String) - Constructor for class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.HtmlLink

I

INIT - Static variable in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

inlineLink(Link) - Method in interface com.github.therapi.runtimejavadoc.CommentVisitor

InlineLink - Class in com.github.therapi.runtimejavadoc

InlineLink(Link) - Constructor for class com.github.therapi.runtimejavadoc.InlineLink

inlineLink(Link) - Method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

inlineLink(Link) - Method in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

inlineTag(String, String) - Method in interface com.github.therapi.runtimejavadoc.CommentVisitor

InlineTag - Class in com.github.therapi.runtimejavadoc

InlineTag(String, String) - Constructor for class com.github.therapi.runtimejavadoc.InlineTag

inlineTag(String, String) - Method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

inlineTag(String, String) - Method in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

inlineValue(Value) - Method in interface com.github.therapi.runtimejavadoc.CommentVisitor

InlineValue - Class in com.github.therapi.runtimejavadoc

InlineValue(Value) - Constructor for class com.github.therapi.runtimejavadoc.InlineValue

inlineValue(Value) - Method in class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

inlineValue(Value) - Method in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

isBlank(String) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

isConstructor() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

isEmpty() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

isPresent() - Method in class com.github.therapi.runtimejavadoc.BaseJavadoc

Deprecated.

use !BaseJavadoc.isEmpty() instead

iterator() - Method in class com.github.therapi.runtimejavadoc.Comment

J

JavadocParser - Class in com.github.therapi.runtimejavadoc.internal.parser

JavadocParser() - Constructor for class com.github.therapi.runtimejavadoc.internal.parser.JavadocParser

javadocResourceSuffix() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

join(CharSequence, Iterable<? extends CharSequence>) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

JsonJavadocReader - Class in com.github.therapi.runtimejavadoc.internal

JsonJavadocReader() - Constructor for class com.github.therapi.runtimejavadoc.internal.JsonJavadocReader

L

lines - Variable in class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

Link - Class in com.github.therapi.runtimejavadoc

Link(String, String, String, List<String>) - Constructor for class com.github.therapi.runtimejavadoc.Link

LinkParser - Class in com.github.therapi.runtimejavadoc.internal.parser

LinkParser() - Constructor for class com.github.therapi.runtimejavadoc.internal.parser.LinkParser

M

matches(Executable) - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

matches(Method) - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

matches(Constructor<?>) - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

MethodJavadoc - Class in com.github.therapi.runtimejavadoc

MethodJavadoc(String, List<String>, Comment, List<ParamJavadoc>, List<ThrowsJavadoc>, List<OtherJavadoc>, Comment, List<SeeAlsoJavadoc>) - Constructor for class com.github.therapi.runtimejavadoc.MethodJavadoc

methodsFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

MethodSignature - Class in com.github.therapi.runtimejavadoc.internal

N

nullToEmpty(Comment) - Static method in class com.github.therapi.runtimejavadoc.Comment

O

OtherJavadoc - Class in com.github.therapi.runtimejavadoc

Unstructured tag with a name and comment.

OtherJavadoc(String, Comment) - Constructor for class com.github.therapi.runtimejavadoc.OtherJavadoc

P

ParamJavadoc - Class in com.github.therapi.runtimejavadoc

ParamJavadoc(String, Comment) - Constructor for class com.github.therapi.runtimejavadoc.ParamJavadoc

paramTypesFieldName() - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

parseClassJavadoc(String, String, List<FieldJavadoc>, List<FieldJavadoc>, List<MethodJavadoc>, List<MethodJavadoc>) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.JavadocParser

parseFieldJavadoc(String, String, String) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.JavadocParser

parseMethodJavadoc(String, String, List<String>, String) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.JavadocParser

parseSeeAlso(String, String) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.SeeAlsoParser

parseTag(String, String) - Static method in class com.github.therapi.runtimejavadoc.internal.parser.ThrowsTagParser

R

readClassJavadoc(String, JsonObject) - Static method in class com.github.therapi.runtimejavadoc.internal.JsonJavadocReader

requireNonNull(T) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

RetainJavadoc - Annotation Type in com.github.therapi.runtimejavadoc

Indicates the annotated element should have its Javadoc made available at runtime, even if it's not in one of the packages specified by the javadoc.packages annotation processor option.

RuntimeJavadoc - Class in com.github.therapi.runtimejavadoc

Allows access to Javadoc elements at runtime for code that was compiled using the therapi-runtime-javadoc-scribe annotation processor.

RuntimeJavadocHelper - Class in com.github.therapi.runtimejavadoc.internal

S

SeeAlsoJavadoc - Class in com.github.therapi.runtimejavadoc

Represents a @see tag on a class or method.

SeeAlsoJavadoc(String) - Constructor for class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

SeeAlsoJavadoc(SeeAlsoJavadoc.HtmlLink) - Constructor for class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

SeeAlsoJavadoc(Link) - Constructor for class com.github.therapi.runtimejavadoc.SeeAlsoJavadoc

SeeAlsoJavadoc.HtmlLink - Class in com.github.therapi.runtimejavadoc

SeeAlsoJavadoc.SeeAlsoType - Enum in com.github.therapi.runtimejavadoc

SeeAlsoParser - Class in com.github.therapi.runtimejavadoc.internal.parser

SeeAlsoParser() - Constructor for class com.github.therapi.runtimejavadoc.internal.parser.SeeAlsoParser

T

ThrowsJavadoc - Class in com.github.therapi.runtimejavadoc

ThrowsJavadoc(String, Comment) - Constructor for class com.github.therapi.runtimejavadoc.ThrowsJavadoc

ThrowsTagParser - Class in com.github.therapi.runtimejavadoc.internal.parser

ThrowsTagParser() - Constructor for class com.github.therapi.runtimejavadoc.internal.parser.ThrowsTagParser

ToHtmlStringCommentVisitor - Class in com.github.therapi.runtimejavadoc

ToHtmlStringCommentVisitor() - Constructor for class com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

toString() - Method in class com.github.therapi.runtimejavadoc.ClassJavadoc

toString() - Method in class com.github.therapi.runtimejavadoc.Comment

toString() - Method in class com.github.therapi.runtimejavadoc.CommentText

toString() - Method in class com.github.therapi.runtimejavadoc.FieldJavadoc

toString() - Method in class com.github.therapi.runtimejavadoc.InlineLink

toString() - Method in class com.github.therapi.runtimejavadoc.InlineValue

toString() - Method in class com.github.therapi.runtimejavadoc.internal.MethodSignature

toString() - Method in class com.github.therapi.runtimejavadoc.internal.parser.BlockTag

toString() - Method in class com.github.therapi.runtimejavadoc.Link

toString() - Method in class com.github.therapi.runtimejavadoc.MethodJavadoc

toString() - Method in class com.github.therapi.runtimejavadoc.OtherJavadoc

toString() - Method in class com.github.therapi.runtimejavadoc.ParamJavadoc

toString() - Method in class com.github.therapi.runtimejavadoc.Value

ToTextListCommentVisitor - Class in com.github.therapi.runtimejavadoc

ToTextListCommentVisitor() - Constructor for class com.github.therapi.runtimejavadoc.ToTextListCommentVisitor

U

unmodifiableDefensiveCopy(List<T>) - Static method in class com.github.therapi.runtimejavadoc.internal.RuntimeJavadocHelper

V

Value - Class in com.github.therapi.runtimejavadoc

Value(String, String) - Constructor for class com.github.therapi.runtimejavadoc.Value

valueOf(String) - Static method in enum com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.SeeAlsoType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.SeeAlsoType

Returns an array containing the constants of this enum type, in the order they are declared.

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.Comment

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.CommentElement

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.CommentText

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.InlineLink

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.InlineTag

visit(CommentVisitor) - Method in class com.github.therapi.runtimejavadoc.InlineValue

B C E F G H I J L M N O P R S T U V