Index (JSON Doclet 0.0.10 API)

A C D E F G H I J K M N O P Q R S T V W
All Classes and Interfaces|All Packages

A

addFile(DirectoryIndex.IndexFileEntry) - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Adds a file entry to the index.
addSubdirectory(DirectoryIndex.SubdirectoryEntry) - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Adds a subdirectory reference to the index.
AnnotationDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Representation of an applied annotation, including element values when present.
AnnotationDocumentation(String, Map<String, String>) - Constructor for record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Creates an instance of a AnnotationDocumentation record class.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns the value of the annotations record component.
annotations() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the annotations record component.
annotationType() - Method in record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Returns the value of the annotationType record component.

C

constantValue() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the constantValue record component.
ConstructorDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Documentation for a constructor.
ConstructorDocumentation(String, String, List<String>, List<AnnotationDocumentation>, List<String>, List<MethodDocumentation.MethodParameter>, List<String>, boolean, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Creates an instance of a ConstructorDocumentation record class.
constructors() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the constructors record component.

D

DirectoryIndex - Class in io.fluxzero.tools.jsondoclet.model: Index metadata generated per output directory.
DirectoryIndex() - Constructor for class io.fluxzero.tools.jsondoclet.model.DirectoryIndex
DirectoryIndex.IndexFileEntry - Record Class in io.fluxzero.tools.jsondoclet.model: Simple file entry describing nearby JSON output.
DirectoryIndex.SubdirectoryEntry - Record Class in io.fluxzero.tools.jsondoclet.model: Subdirectory pointer for discovery.
DocGenerationTask - Class in io.fluxzero.tools.jsondoclet.core: Coordinates traversal and writing of documentation artifacts.
DocGenerationTask(DocletConfiguration, DocletEnvironment, Reporter) - Constructor for class io.fluxzero.tools.jsondoclet.core.DocGenerationTask: Creates a new task bound to the supplied doclet execution context.
DocletConfiguration - Record Class in io.fluxzero.tools.jsondoclet.config: Immutable configuration for JSON doclet execution.
DocletConfiguration(Path, boolean, boolean) - Constructor for record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Creates an instance of a DocletConfiguration record class.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns the value of the documentation record component.
documentation() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the documentation record component.

E

EnumConstantDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Documentation for an enum constant.
EnumConstantDocumentation(String, String, List<AnnotationDocumentation>, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Creates an instance of a EnumConstantDocumentation record class.
enumConstants() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the enumConstants record component.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Indicates whether some other object is "equal to" this one.
execute() - Method in class io.fluxzero.tools.jsondoclet.core.DocGenerationTask: Executes the traversal of packages and types, writing JSON files and indexes.

F

FieldDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Documentation for a field declaration.
FieldDocumentation(String, String, String, List<String>, List<AnnotationDocumentation>, String, Object) - Constructor for record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Creates an instance of a FieldDocumentation record class.
fields() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the fields record component.
file() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns the value of the file record component.

G

getFiles() - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Files in the current directory that point to generated JSON artifacts.
getName() - Method in class io.fluxzero.tools.jsondoclet.JsonDoclet
getPackage() - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Returns documentation metadata for the package corresponding to this directory, if any.
getSubdirectories() - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Subdirectories that contain further index files.
getSupportedOptions() - Method in class io.fluxzero.tools.jsondoclet.JsonDoclet
getSupportedSourceVersion() - Method in class io.fluxzero.tools.jsondoclet.JsonDoclet

H

hashCode() - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns a hash code value for this object.
hashCode() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns a hash code value for this object.

I

includePrivate() - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Returns the value of the includePrivate record component.
IndexFileEntry(String, String, String, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Creates an instance of a IndexFileEntry record class.
init(Locale, Reporter) - Method in class io.fluxzero.tools.jsondoclet.JsonDoclet
interfaces() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the interfaces record component.
io.fluxzero.tools.jsondoclet - package io.fluxzero.tools.jsondoclet
io.fluxzero.tools.jsondoclet.config - package io.fluxzero.tools.jsondoclet.config
io.fluxzero.tools.jsondoclet.core - package io.fluxzero.tools.jsondoclet.core
io.fluxzero.tools.jsondoclet.model - package io.fluxzero.tools.jsondoclet.model
io.fluxzero.tools.jsondoclet.util - package io.fluxzero.tools.jsondoclet.util

J

JsonDoclet - Class in io.fluxzero.tools.jsondoclet: Doclet entry point that produces JSON output instead of HTML.
JsonDoclet() - Constructor for class io.fluxzero.tools.jsondoclet.JsonDoclet: Default constructor required by the doclet infrastructure.
JsonWriter - Class in io.fluxzero.tools.jsondoclet.util: Minimal JSON serializer tailored to the doclet's data model.

K

kind() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns the value of the kind record component.
kind() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns the value of the kind record component.
kind() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the kind record component.

M

MethodDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Documentation extracted for an individual method.
MethodDocumentation(String, String, String, List<String>, List<AnnotationDocumentation>, List<String>, List<MethodDocumentation.MethodParameter>, List<String>, boolean, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Creates an instance of a MethodDocumentation record class.
MethodDocumentation.MethodParameter - Record Class in io.fluxzero.tools.jsondoclet.model: Method parameter descriptor capturing the declaration type and name.
MethodParameter(String, String, boolean, List<AnnotationDocumentation>) - Constructor for record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Creates an instance of a MethodParameter record class.
methods() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the methods record component.
modifiers() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the modifiers record component.
modifiers() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the modifiers record component.
modifiers() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the modifiers record component.
modifiers() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns the value of the modifiers record component.
modifiers() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the modifiers record component.

N

name() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns the value of the name record component.
name() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the name record component.
NestedTypeDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Summary information for nested/inner types declared within a parent.
NestedTypeDocumentation(String, String, String, List<String>, List<AnnotationDocumentation>) - Constructor for record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Creates an instance of a NestedTypeDocumentation record class.
nestedTypes() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the nestedTypes record component.

O

outputDirectory() - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Returns the value of the outputDirectory record component.

P

PackageDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Minimal representation of package-level documentation.
PackageDocumentation(String, String, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Creates an instance of a PackageDocumentation record class.
packageName() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the packageName record component.
parameters() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the parameters record component.
parameters() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the parameters record component.
path() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Returns the value of the path record component.
prettyPrint() - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Returns the value of the prettyPrint record component.

Q

qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Returns the value of the qualifiedName record component.
qualifiedName() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the qualifiedName record component.

R

RecordComponentDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Documentation for a record component (Java 16+).
RecordComponentDocumentation(String, String, List<AnnotationDocumentation>, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Creates an instance of a RecordComponentDocumentation record class.
recordComponents() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the recordComponents record component.
returnType() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the returnType record component.
run(DocletEnvironment) - Method in class io.fluxzero.tools.jsondoclet.JsonDoclet

S

setPackage(PackageDocumentation) - Method in class io.fluxzero.tools.jsondoclet.model.DirectoryIndex: Assigns package-level documentation metadata to this directory.
SubdirectoryEntry(String, String) - Constructor for record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Creates an instance of a SubdirectoryEntry record class.
superClass() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the superClass record component.

T

thrownTypes() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the thrownTypes record component.
thrownTypes() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the thrownTypes record component.
toString() - Method in record class io.fluxzero.tools.jsondoclet.config.DocletConfiguration: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.DirectoryIndex.SubdirectoryEntry: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.EnumConstantDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.NestedTypeDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.PackageDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns a string representation of this record class.
toString() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns a string representation of this record class.
type() - Method in record class io.fluxzero.tools.jsondoclet.model.FieldDocumentation: Returns the value of the type record component.
type() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns the value of the type record component.
type() - Method in record class io.fluxzero.tools.jsondoclet.model.RecordComponentDocumentation: Returns the value of the type record component.
TypeDocumentation - Record Class in io.fluxzero.tools.jsondoclet.model: Aggregated documentation for a single declared type.
TypeDocumentation(String, String, String, String, List<String>, List<AnnotationDocumentation>, String, List<String>, String, List<String>, List<FieldDocumentation>, List<ConstructorDocumentation>, List<MethodDocumentation>, List<EnumConstantDocumentation>, List<RecordComponentDocumentation>, List<NestedTypeDocumentation>) - Constructor for record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Creates an instance of a TypeDocumentation record class.
typeParameters() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the typeParameters record component.
typeParameters() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the typeParameters record component.
typeParameters() - Method in record class io.fluxzero.tools.jsondoclet.model.TypeDocumentation: Returns the value of the typeParameters record component.

V

values() - Method in record class io.fluxzero.tools.jsondoclet.model.AnnotationDocumentation: Returns the value of the values record component.
varArgs() - Method in record class io.fluxzero.tools.jsondoclet.model.ConstructorDocumentation: Returns the value of the varArgs record component.
varArgs() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation.MethodParameter: Returns the value of the varArgs record component.
varArgs() - Method in record class io.fluxzero.tools.jsondoclet.model.MethodDocumentation: Returns the value of the varArgs record component.

W

write(Path, Object, boolean) - Static method in class io.fluxzero.tools.jsondoclet.util.JsonWriter: Serializes the supplied value to the given path.

A C D E F G H I J K M N O P Q R S T V W
All Classes and Interfaces|All Packages