Package io.micrometer.docs.commons

Class AbstractSearchingFileVisitor

java.lang.Object

java.nio.file.SimpleFileVisitor<Path>

io.micrometer.docs.commons.AbstractSearchingFileVisitor

All Implemented Interfaces:

FileVisitor<Path>

public abstract class AbstractSearchingFileVisitor
extends SimpleFileVisitor<Path>

Shared logic to process documentation enum classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSearchingFileVisitor.NameInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected final Pattern	pattern
protected final JavaSourceSearchHelper	searchHelper

Constructor Summary

Constructors

Constructor	Description
AbstractSearchingFileVisitor(Pattern pattern, JavaSourceSearchHelper searchHelper)

Method Summary

Modifier and Type	Method	Description
abstract void	onEnumConstant(org.jboss.forge.roaster.model.source.JavaEnumSource enclosingEnumSource, org.jboss.forge.roaster.model.source.EnumConstantSource enumConstant)
protected <T> List<T>	retrieveEnumValues(org.jboss.forge.roaster.model.source.JavaSource<?> enclosingJavaSource, org.jboss.forge.roaster.model.source.MethodSource<?> methodSource, EntryEnumConstantReader<?> converter)
abstract Collection<Class<?>>	supportedInterfaces()
protected void	validateNameOrConvention(String name, String conventionClassName, org.jboss.forge.roaster.model.source.JavaEnumSource enclosingEnum)
protected List<String>	validatePrefixOnTags(String prefix, List<KeyNameEntry> tags, String enumName, String enclosingClassName)	Check given tags start with the given prefix.
FileVisitResult	visitFile(Path path, BasicFileAttributes attrs)

Methods inherited from class java.nio.file.SimpleFileVisitor

postVisitDirectory, preVisitDirectory, visitFileFailed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

pattern

protected final Pattern pattern

searchHelper

protected final JavaSourceSearchHelper searchHelper

Constructor Details

AbstractSearchingFileVisitor

public AbstractSearchingFileVisitor(Pattern pattern,
 JavaSourceSearchHelper searchHelper)

Method Details

visitFile

public FileVisitResult visitFile(Path path,
 BasicFileAttributes attrs)
                          throws IOException

Specified by:

visitFile in interface FileVisitor<Path>

Overrides:

visitFile in class SimpleFileVisitor<Path>

Throws:

IOException

supportedInterfaces

public abstract Collection<Class<?>> supportedInterfaces()

onEnumConstant

public abstract void onEnumConstant(org.jboss.forge.roaster.model.source.JavaEnumSource enclosingEnumSource,
 org.jboss.forge.roaster.model.source.EnumConstantSource enumConstant)

validateNameOrConvention

protected void validateNameOrConvention(String name,
 @Nullable
 String conventionClassName,
 org.jboss.forge.roaster.model.source.JavaEnumSource enclosingEnum)

retrieveEnumValues

protected <T> List<T> retrieveEnumValues(org.jboss.forge.roaster.model.source.JavaSource<?> enclosingJavaSource,
 org.jboss.forge.roaster.model.source.MethodSource<?> methodSource,
 EntryEnumConstantReader<?> converter)

validatePrefixOnTags

protected List<String> validatePrefixOnTags(String prefix,
 List<KeyNameEntry> tags,
 String enumName,
 String enclosingClassName)

Check given tags start with the given prefix.

Parameters:

prefix - tag name prefix

tags - tags

enumName - the enum constant

enclosingClassName - the enclosing enum class name

Returns:

list of invalid tag messages