Index

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

A

AbstractSearchingFileVisitor - Class in io.micrometer.docs.commons

Shared logic to process documentation enum classes.

AbstractSearchingFileVisitor(Pattern, JavaSourceSearchHelper) - Constructor for class io.micrometer.docs.commons.AbstractSearchingFileVisitor

AbstractSearchingFileVisitor.NameInfo - Class in io.micrometer.docs.commons

ADocHelpers - Class in io.micrometer.docs.commons.templates

Helper source class for handlebars.

ADocHelpers() - Constructor for class io.micrometer.docs.commons.templates.ADocHelpers

apply(EnumConstantSource) - Method in class io.micrometer.docs.commons.EventEntryForMetricEnumConstantReader

apply(EnumConstantSource) - Method in class io.micrometer.docs.commons.EventEntryForSpanEnumConstantReader

apply(EnumConstantSource) - Method in class io.micrometer.docs.commons.EventValueEntryEnumConstantReader

apply(EnumConstantSource) - Method in class io.micrometer.docs.commons.KeyNameEnumConstantReader

AsciidocUtils - Class in io.micrometer.docs.commons.utils

Utilities to parse javadoc fragments in various form (String, modelling objects) to asciidoc strings.

AsciidocUtils() - Constructor for class io.micrometer.docs.commons.utils.AsciidocUtils

Assert - Class in io.micrometer.docs.commons.utils

Assert() - Constructor for class io.micrometer.docs.commons.utils.Assert

C

capitalize(String) - Static method in class io.micrometer.docs.commons.utils.StringUtils

compareTo(EventEntry) - Method in class io.micrometer.docs.commons.EventEntry

compareTo(KeyNameEntry) - Method in class io.micrometer.docs.commons.KeyNameEntry

create(Path, Pattern) - Static method in class io.micrometer.docs.commons.JavaSourceSearchHelper

createHandlebars() - Static method in class io.micrometer.docs.commons.templates.HandlebarsUtils

createTemplate(String) - Static method in class io.micrometer.docs.commons.templates.HandlebarsUtils

Create a handlebar Template from template location.

D

DocsGeneratorCommand - Class in io.micrometer.docs

Entry point for document generation.

DocsGeneratorCommand() - Constructor for class io.micrometer.docs.DocsGeneratorCommand

E

EntryEnumConstantReader<T> - Interface in io.micrometer.docs.commons

Model object for .Event.

EventEntry - Class in io.micrometer.docs.commons

Model object for Observation.Event and EventValue.

EventEntry() - Constructor for class io.micrometer.docs.commons.EventEntry

EventEntryForMetricEnumConstantReader - Class in io.micrometer.docs.commons

Responsible for reading Observation.Event enum source for metric.

EventEntryForMetricEnumConstantReader() - Constructor for class io.micrometer.docs.commons.EventEntryForMetricEnumConstantReader

EventEntryForSpanEnumConstantReader - Class in io.micrometer.docs.commons

Responsible for reading Observation.Event enum source for span.

EventEntryForSpanEnumConstantReader() - Constructor for class io.micrometer.docs.commons.EventEntryForSpanEnumConstantReader

EventValueEntryEnumConstantReader - Class in io.micrometer.docs.commons

Responsible for reading EventValue enum source.

EventValueEntryEnumConstantReader() - Constructor for class io.micrometer.docs.commons.EventValueEntryEnumConstantReader

expressionFromReturnMethodDeclaration(MethodSource<?>) - Static method in class io.micrometer.docs.commons.ParsingUtils

G

generate() - Method in class io.micrometer.docs.conventions.ObservationConventionsDocGenerator

generate() - Method in class io.micrometer.docs.metrics.MetricsDocGenerator

generate() - Method in class io.micrometer.docs.spans.SpansDocGenerator

getDescription() - Method in class io.micrometer.docs.commons.EventEntry

getDescription() - Method in class io.micrometer.docs.commons.KeyNameEntry

getDisplayDescription() - Method in class io.micrometer.docs.commons.EventEntry

getDisplayDescription() - Method in class io.micrometer.docs.commons.KeyNameEntry

getMethodDeclaration(MethodSource<?>) - Static method in class io.micrometer.docs.commons.ParsingUtils

Retrieve MethodDeclaration from MethodSource.

getName() - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor.NameInfo

getName() - Method in class io.micrometer.docs.commons.EventEntry

getName() - Method in class io.micrometer.docs.commons.KeyNameEntry

getNameOrigin() - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor.NameInfo

getRequiredClass() - Method in interface io.micrometer.docs.commons.EntryEnumConstantReader

getRequiredClass() - Method in class io.micrometer.docs.commons.EventEntryForMetricEnumConstantReader

getRequiredClass() - Method in class io.micrometer.docs.commons.EventEntryForSpanEnumConstantReader

getRequiredClass() - Method in class io.micrometer.docs.commons.EventValueEntryEnumConstantReader

getRequiredClass() - Method in class io.micrometer.docs.commons.KeyNameEnumConstantReader

H

HandlebarsUtils - Class in io.micrometer.docs.commons.templates

Utility for Handlebars.

HandlebarsUtils() - Constructor for class io.micrometer.docs.commons.templates.HandlebarsUtils

hasText(String) - Static method in class io.micrometer.docs.commons.utils.StringUtils

hasText(String, String) - Static method in class io.micrometer.docs.commons.utils.Assert

I

INSTANCE - Static variable in class io.micrometer.docs.commons.EventEntryForMetricEnumConstantReader

INSTANCE - Static variable in class io.micrometer.docs.commons.EventEntryForSpanEnumConstantReader

INSTANCE - Static variable in class io.micrometer.docs.commons.EventValueEntryEnumConstantReader

INSTANCE - Static variable in class io.micrometer.docs.commons.KeyNameEnumConstantReader

io.micrometer.docs - package io.micrometer.docs

Documentation generation.

io.micrometer.docs.commons - package io.micrometer.docs.commons

Common classes.

io.micrometer.docs.commons.templates - package io.micrometer.docs.commons.templates

Templates.

io.micrometer.docs.commons.utils - package io.micrometer.docs.commons.utils

Utilities.

io.micrometer.docs.conventions - package io.micrometer.docs.conventions

Documentation for observation conventions.

io.micrometer.docs.metrics - package io.micrometer.docs.metrics

Documentation for metrics.

io.micrometer.docs.spans - package io.micrometer.docs.spans

Documentation for spans.

isDynamic(String) - Static method in class io.micrometer.docs.commons.templates.ADocHelpers

isInstanceOf(Class<?>, Object) - Static method in class io.micrometer.docs.commons.utils.Assert

isInstanceOf(Class<?>, Object, String) - Static method in class io.micrometer.docs.commons.utils.Assert

isRequired() - Method in class io.micrometer.docs.commons.KeyNameEntry

J

javadocToAsciidoc(JavaDocSource<?>) - Static method in class io.micrometer.docs.commons.utils.AsciidocUtils

JavaSourceSearchHelper - Class in io.micrometer.docs.commons

Helper class to search any JavaSource from java files under specified directory.

K

KeyNameEntry - Class in io.micrometer.docs.commons

Model object for KeyName.

KeyNameEntry() - Constructor for class io.micrometer.docs.commons.KeyNameEntry

KeyNameEnumConstantReader - Class in io.micrometer.docs.commons

Responsible for reading KeyName enum source.

KeyNameEnumConstantReader() - Constructor for class io.micrometer.docs.commons.KeyNameEnumConstantReader

M

main(String...) - Static method in class io.micrometer.docs.DocsGeneratorCommand

MetricsDocGenerator - Class in io.micrometer.docs.metrics

MetricsDocGenerator(File, Pattern, String, Path) - Constructor for class io.micrometer.docs.metrics.MetricsDocGenerator

N

NameInfo(String, String) - Constructor for class io.micrometer.docs.commons.AbstractSearchingFileVisitor.NameInfo

notNull(Object, String) - Static method in class io.micrometer.docs.commons.utils.Assert

O

ObservationConventionsDocGenerator - Class in io.micrometer.docs.conventions

ObservationConventionsDocGenerator(File, Pattern, String, Path) - Constructor for class io.micrometer.docs.conventions.ObservationConventionsDocGenerator

onEnumConstant(JavaEnumSource, EnumConstantSource) - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

P

ParsingUtils - Class in io.micrometer.docs.commons

ParsingUtils() - Constructor for class io.micrometer.docs.commons.ParsingUtils

pattern - Variable in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

R

readEnumClassNames(MethodSource<?>) - Static method in class io.micrometer.docs.commons.ParsingUtils

readStringReturnValue(MethodSource<?>) - Static method in class io.micrometer.docs.commons.ParsingUtils

Read the return statement value as string.

retrieveEnumValues(JavaSource<?>, MethodSource<?>, EntryEnumConstantReader<?>) - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

retrieveModelsFromEnum(JavaEnumSource, EntryEnumConstantReader<?>) - Static method in class io.micrometer.docs.commons.ParsingUtils

run() - Method in class io.micrometer.docs.DocsGeneratorCommand

S

search(String) - Method in class io.micrometer.docs.commons.JavaSourceSearchHelper

Search a JavaSource by qualified class name.

searchHelper - Variable in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

searchMethodSource(JavaSource<?>, String) - Method in class io.micrometer.docs.commons.JavaSourceSearchHelper

Search the method source in the hierarchy(parents/interfaces) of the given JavaSource.

searchObservationConventionInterfaceName(JavaSource<?>) - Method in class io.micrometer.docs.commons.JavaSourceSearchHelper

Hierarchically search the implementing name of ObservationConvention or GlobalObservationConvention.

searchReferencingClass(JavaSource<?>, String) - Method in class io.micrometer.docs.commons.JavaSourceSearchHelper

Search the class which is referenced by the enclosing class.

searchReferencingEnumConstant(JavaSource<?>, Expression) - Method in class io.micrometer.docs.commons.JavaSourceSearchHelper

Search an enum constant referenced by the enclosing class.

setDescription(String) - Method in class io.micrometer.docs.commons.EventEntry

setDescription(String) - Method in class io.micrometer.docs.commons.KeyNameEntry

setName(String) - Method in class io.micrometer.docs.commons.EventEntry

setName(String) - Method in class io.micrometer.docs.commons.KeyNameEntry

setRequired(boolean) - Method in class io.micrometer.docs.commons.KeyNameEntry

simpleHtmlToAsciidoc(String, boolean) - Static method in class io.micrometer.docs.commons.utils.AsciidocUtils

simpleTagletToAsciidoc(String, List<?>) - Static method in class io.micrometer.docs.commons.utils.AsciidocUtils

SpansDocGenerator - Class in io.micrometer.docs.spans

SpansDocGenerator(File, Pattern, String, Path) - Constructor for class io.micrometer.docs.spans.SpansDocGenerator

StringUtils - Class in io.micrometer.docs.commons.utils

StringUtils() - Constructor for class io.micrometer.docs.commons.utils.StringUtils

supportedInterfaces() - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

V

validateNameOrConvention(String, String, JavaEnumSource) - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

validatePrefixOnTags(String, List<KeyNameEntry>, String, String) - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

Check given tags start with the given prefix.

visitFile(Path, BasicFileAttributes) - Method in class io.micrometer.docs.commons.AbstractSearchingFileVisitor

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