Class AugmentedIndexView

java.lang.Object
io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
All Implemented Interfaces:
org.jboss.jandex.IndexView

public class AugmentedIndexView extends Object implements org.jboss.jandex.IndexView
IndexView augmented with additional methods for common operations used throughout the data object scanning code.
Author:
Marc Savy <marc@rhymewithgravy.com>
  • Method Summary

    Modifier and Type
    Method
    Description
    Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.MethodInfo>
    ancestry(org.jboss.jandex.MethodInfo method)
     
    augment(org.jboss.jandex.IndexView index)
     
    boolean
    containsClass(org.jboss.jandex.Type type)
     
    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.ClassInfo>
    getAllKnownSubinterfaces(org.jboss.jandex.DotName interfaceName)
     
    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
    getClass(Class<?> klazz)
     
    org.jboss.jandex.ClassInfo
    getClass(org.jboss.jandex.Type type)
     
    org.jboss.jandex.ClassInfo
    getClassByName(org.jboss.jandex.DotName className)
     
    Collection<org.jboss.jandex.ClassInfo>
    getClassesInPackage(org.jboss.jandex.DotName packageName)
     
    Collection<org.jboss.jandex.ClassInfo>
     
    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.ClassInfo>
    getKnownDirectSubinterfaces(org.jboss.jandex.DotName interfaceName)
     
    Collection<org.jboss.jandex.ModuleInfo>
     
    Collection<org.jboss.jandex.ClassInfo>
    getKnownUsers(org.jboss.jandex.DotName className)
     
    org.jboss.jandex.ModuleInfo
    getModuleByName(org.jboss.jandex.DotName moduleName)
     
    Set<org.jboss.jandex.DotName>
    getSubpackages(org.jboss.jandex.DotName packageName)
     
    Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.Type>
    inheritanceChain(org.jboss.jandex.ClassInfo klazz, org.jboss.jandex.Type type)
    Builds an insertion-order map of a class's inheritance chain, starting with the klazz argument.
    Set<org.jboss.jandex.Type>
    interfaces(org.jboss.jandex.ClassInfo klass)
    Retrieve the unique Types that the given ClassInfo implements.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.jboss.jandex.IndexView

    getAllKnownImplementors, getAllKnownImplementors, getAllKnownSubclasses, getAllKnownSubclasses, getAllKnownSubinterfaces, getAllKnownSubinterfaces, getAnnotations, getAnnotations, getAnnotationsWithRepeatable, getAnnotationsWithRepeatable, getClassByName, getClassByName, getClassesInPackage, getKnownDirectImplementors, getKnownDirectImplementors, getKnownDirectSubclasses, getKnownDirectSubclasses, getKnownDirectSubinterfaces, getKnownDirectSubinterfaces, getKnownUsers, getKnownUsers, getModuleByName, getSubpackages
  • Method Details

    • augment

      public static AugmentedIndexView augment(org.jboss.jandex.IndexView index)
    • getClass

      public org.jboss.jandex.ClassInfo getClass(org.jboss.jandex.Type type)
    • containsClass

      public boolean containsClass(org.jboss.jandex.Type type)
    • getClass

      public org.jboss.jandex.ClassInfo getClass(Class<?> klazz)
    • interfaces

      public Set<org.jboss.jandex.Type> interfaces(org.jboss.jandex.ClassInfo klass)
      Retrieve the unique Types that the given ClassInfo implements.
      Parameters:
      klass -
      Returns:
      the Set of interfaces
    • inheritanceChain

      public Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.Type> inheritanceChain(org.jboss.jandex.ClassInfo klazz, org.jboss.jandex.Type type)
      Builds an insertion-order map of a class's inheritance chain, starting with the klazz argument.
      Parameters:
      klazz - the class to retrieve inheritance
      type - type of the klazz
      Returns:
      map of a class's inheritance chain/ancestry
    • ancestry

      public Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.MethodInfo> ancestry(org.jboss.jandex.MethodInfo method)
    • getKnownClasses

      public Collection<org.jboss.jandex.ClassInfo> getKnownClasses()
      Specified by:
      getKnownClasses in interface org.jboss.jandex.IndexView
    • getClassByName

      public org.jboss.jandex.ClassInfo getClassByName(org.jboss.jandex.DotName className)
      Specified by:
      getClassByName in interface org.jboss.jandex.IndexView
    • getKnownDirectSubclasses

      public Collection<org.jboss.jandex.ClassInfo> getKnownDirectSubclasses(org.jboss.jandex.DotName className)
      Specified by:
      getKnownDirectSubclasses in interface org.jboss.jandex.IndexView
    • getAllKnownSubclasses

      public Collection<org.jboss.jandex.ClassInfo> getAllKnownSubclasses(org.jboss.jandex.DotName className)
      Specified by:
      getAllKnownSubclasses in interface org.jboss.jandex.IndexView
    • getKnownDirectSubinterfaces

      public Collection<org.jboss.jandex.ClassInfo> getKnownDirectSubinterfaces(org.jboss.jandex.DotName interfaceName)
      Specified by:
      getKnownDirectSubinterfaces in interface org.jboss.jandex.IndexView
    • getAllKnownSubinterfaces

      public Collection<org.jboss.jandex.ClassInfo> getAllKnownSubinterfaces(org.jboss.jandex.DotName interfaceName)
      Specified by:
      getAllKnownSubinterfaces in interface org.jboss.jandex.IndexView
    • getKnownDirectImplementors

      public Collection<org.jboss.jandex.ClassInfo> getKnownDirectImplementors(org.jboss.jandex.DotName className)
      Specified by:
      getKnownDirectImplementors in interface org.jboss.jandex.IndexView
    • getAllKnownImplementors

      public Collection<org.jboss.jandex.ClassInfo> getAllKnownImplementors(org.jboss.jandex.DotName interfaceName)
      Specified by:
      getAllKnownImplementors in interface org.jboss.jandex.IndexView
    • getAnnotations

      public Collection<org.jboss.jandex.AnnotationInstance> getAnnotations(org.jboss.jandex.DotName annotationName)
      Specified by:
      getAnnotations in interface org.jboss.jandex.IndexView
    • getAnnotationsWithRepeatable

      public Collection<org.jboss.jandex.AnnotationInstance> getAnnotationsWithRepeatable(org.jboss.jandex.DotName annotationName, org.jboss.jandex.IndexView annotationIndex)
      Specified by:
      getAnnotationsWithRepeatable in interface org.jboss.jandex.IndexView
    • getKnownModules

      public Collection<org.jboss.jandex.ModuleInfo> getKnownModules()
      Specified by:
      getKnownModules in interface org.jboss.jandex.IndexView
    • getModuleByName

      public org.jboss.jandex.ModuleInfo getModuleByName(org.jboss.jandex.DotName moduleName)
      Specified by:
      getModuleByName in interface org.jboss.jandex.IndexView
    • getKnownUsers

      public Collection<org.jboss.jandex.ClassInfo> getKnownUsers(org.jboss.jandex.DotName className)
      Specified by:
      getKnownUsers in interface org.jboss.jandex.IndexView
    • getClassesInPackage

      public Collection<org.jboss.jandex.ClassInfo> getClassesInPackage(org.jboss.jandex.DotName packageName)
      Specified by:
      getClassesInPackage in interface org.jboss.jandex.IndexView
    • getSubpackages

      public Set<org.jboss.jandex.DotName> getSubpackages(org.jboss.jandex.DotName packageName)
      Specified by:
      getSubpackages in interface org.jboss.jandex.IndexView