Class FilteredIndexView
- java.lang.Object
-
- io.smallrye.openapi.runtime.scanner.FilteredIndexView
-
- All Implemented Interfaces:
org.jboss.jandex.IndexView
public class FilteredIndexView extends Object implements org.jboss.jandex.IndexView
Wraps anIndexView
instance and filters the contents based on the settings provided viaOpenApiConfig
.- Author:
- [email protected]
-
-
Constructor Summary
Constructors Constructor Description FilteredIndexView(org.jboss.jandex.IndexView delegate, OpenApiConfig config)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accepts(org.jboss.jandex.DotName className)
Returns true if the class name should be included in the index (is either included or not excluded).boolean
accepts(org.jboss.jandex.DotName className, boolean allowImpliedInclusion)
Returns true if the class name should be included in the index (is either included or not excluded).boolean
explicitlyAccepts(org.jboss.jandex.DotName className)
Returns true if the class name should be included in the index, only when explicitly included (and not excluded) via configuration.Collection<org.jboss.jandex.ClassInfo>
getAllKnownImplementors(org.jboss.jandex.DotName interfaceName)
Collection<org.jboss.jandex.ClassInfo>
getAllKnownSubclasses(org.jboss.jandex.DotName className)
Collection<org.jboss.jandex.AnnotationInstance>
getAnnotations(org.jboss.jandex.DotName annotationName)
Collection<org.jboss.jandex.AnnotationInstance>
getAnnotationsWithRepeatable(org.jboss.jandex.DotName annotationName, org.jboss.jandex.IndexView annotationIndex)
org.jboss.jandex.ClassInfo
getClassByName(org.jboss.jandex.DotName className)
Collection<org.jboss.jandex.ClassInfo>
getKnownClasses()
Collection<org.jboss.jandex.ClassInfo>
getKnownDirectImplementors(org.jboss.jandex.DotName className)
Collection<org.jboss.jandex.ClassInfo>
getKnownDirectSubclasses(org.jboss.jandex.DotName className)
Collection<org.jboss.jandex.ModuleInfo>
getKnownModules()
Collection<org.jboss.jandex.ClassInfo>
getKnownUsers(org.jboss.jandex.DotName className)
org.jboss.jandex.ModuleInfo
getModuleByName(org.jboss.jandex.DotName moduleName)
-
-
-
Constructor Detail
-
FilteredIndexView
public FilteredIndexView(org.jboss.jandex.IndexView delegate, OpenApiConfig config)
Constructor.- Parameters:
delegate
- the original (to be wrapped) indexconfig
- the config
-
-
Method Detail
-
accepts
public boolean accepts(org.jboss.jandex.DotName className)
Returns true if the class name should be included in the index (is either included or not excluded).- Parameters:
className
- the name of the class- Returns:
- true if the inclusion/exclusion configuration allows scanning of the class name
-
explicitlyAccepts
public boolean explicitlyAccepts(org.jboss.jandex.DotName className)
Returns true if the class name should be included in the index, only when explicitly included (and not excluded) via configuration.- Parameters:
className
- the name of the class- Returns:
- true if the inclusion/exclusion configuration allows scanning of the class name
-
accepts
public boolean accepts(org.jboss.jandex.DotName className, boolean allowImpliedInclusion)
Returns true if the class name should be included in the index (is either included or not excluded).- Parameters:
className
- the name of the classallowImpliedInclusion
- whether the class may be implied for inclusion- Returns:
- true if the inclusion/exclusion configuration allows scanning of the class name
-
getKnownClasses
public Collection<org.jboss.jandex.ClassInfo> getKnownClasses()
- Specified by:
getKnownClasses
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getKnownClasses()
-
getClassByName
public org.jboss.jandex.ClassInfo getClassByName(org.jboss.jandex.DotName className)
- Specified by:
getClassByName
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getClassByName(org.jboss.jandex.DotName)
-
getKnownDirectSubclasses
public Collection<org.jboss.jandex.ClassInfo> getKnownDirectSubclasses(org.jboss.jandex.DotName className)
- Specified by:
getKnownDirectSubclasses
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getKnownDirectSubclasses(org.jboss.jandex.DotName)
-
getAllKnownSubclasses
public Collection<org.jboss.jandex.ClassInfo> getAllKnownSubclasses(org.jboss.jandex.DotName className)
- Specified by:
getAllKnownSubclasses
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getAllKnownSubclasses(org.jboss.jandex.DotName)
-
getKnownDirectImplementors
public Collection<org.jboss.jandex.ClassInfo> getKnownDirectImplementors(org.jboss.jandex.DotName className)
- Specified by:
getKnownDirectImplementors
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getKnownDirectImplementors(org.jboss.jandex.DotName)
-
getAllKnownImplementors
public Collection<org.jboss.jandex.ClassInfo> getAllKnownImplementors(org.jboss.jandex.DotName interfaceName)
- Specified by:
getAllKnownImplementors
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getAllKnownImplementors(org.jboss.jandex.DotName)
-
getAnnotations
public Collection<org.jboss.jandex.AnnotationInstance> getAnnotations(org.jboss.jandex.DotName annotationName)
- Specified by:
getAnnotations
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getAnnotations(org.jboss.jandex.DotName)
-
getAnnotationsWithRepeatable
public Collection<org.jboss.jandex.AnnotationInstance> getAnnotationsWithRepeatable(org.jboss.jandex.DotName annotationName, org.jboss.jandex.IndexView annotationIndex)
- Specified by:
getAnnotationsWithRepeatable
in interfaceorg.jboss.jandex.IndexView
- See Also:
IndexView.getAnnotationsWithRepeatable(org.jboss.jandex.DotName, org.jboss.jandex.IndexView)
-
getKnownModules
public Collection<org.jboss.jandex.ModuleInfo> getKnownModules()
- Specified by:
getKnownModules
in interfaceorg.jboss.jandex.IndexView
-
getModuleByName
public org.jboss.jandex.ModuleInfo getModuleByName(org.jboss.jandex.DotName moduleName)
- Specified by:
getModuleByName
in interfaceorg.jboss.jandex.IndexView
-
getKnownUsers
public Collection<org.jboss.jandex.ClassInfo> getKnownUsers(org.jboss.jandex.DotName className)
- Specified by:
getKnownUsers
in interfaceorg.jboss.jandex.IndexView
-
-