Package org.apache.maven.tools.plugin.extractor.annotations

Class JavaSourceModel

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public final class JavaSourceModel
extends java.lang.Object
implements java.io.Closeable
    Source declarations and type resolution used while extracting Javadocs.

    • Constructor Summary

      Constructors 
      Constructor Description
      JavaSourceModel​(java.nio.charset.Charset encoding)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addClassPathEntry​(java.io.File entry)  
      void addSourceDirectory​(java.io.File directory)  
      void close()  
      java.lang.String getLocation​(com.github.javaparser.ast.Node node, int fallbackLine)  
      java.util.Optional<java.lang.String> getModuleName​(java.lang.String packageName)  
      java.util.Optional<com.github.javaparser.ast.body.TypeDeclaration<?>> getType​(com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration declaration)  
      java.util.Optional<com.github.javaparser.ast.body.TypeDeclaration<?>> getType​(java.lang.String fullyQualifiedName)  
      java.util.Collection<com.github.javaparser.ast.body.TypeDeclaration<?>> getTypes()  
      com.github.javaparser.resolution.TypeSolver getTypeSolver()  
      boolean hasPackage​(java.lang.String packageName)  
      boolean isInternal​(com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration declaration)  
      boolean isInternalPackage​(java.lang.String packageName)  
      void parse()  
      java.util.Optional<com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration> resolveType​(java.lang.String fullyQualifiedName)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JavaSourceModel

        public JavaSourceModel​(java.nio.charset.Charset encoding)

    • Method Detail

      • addSourceDirectory

        public void addSourceDirectory​(java.io.File directory)
                        throws java.io.IOException
        Throws:
        java.io.IOException

      • addClassPathEntry

        public void addClassPathEntry​(java.io.File entry)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parse

        public void parse()
           throws java.io.IOException
        Throws:
        java.io.IOException

      • getTypes

        public java.util.Collection<com.github.javaparser.ast.body.TypeDeclaration<?>> getTypes()

      • getType

        public java.util.Optional<com.github.javaparser.ast.body.TypeDeclaration<?>> getType​(java.lang.String fullyQualifiedName)

      • getType

        public java.util.Optional<com.github.javaparser.ast.body.TypeDeclaration<?>> getType​(com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration declaration)

      • getModuleName

        public java.util.Optional<java.lang.String> getModuleName​(java.lang.String packageName)

      • hasPackage

        public boolean hasPackage​(java.lang.String packageName)

      • isInternal

        public boolean isInternal​(com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration declaration)

      • isInternalPackage

        public boolean isInternalPackage​(java.lang.String packageName)

      • resolveType

        public java.util.Optional<com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration> resolveType​(java.lang.String fullyQualifiedName)

      • getTypeSolver

        public com.github.javaparser.resolution.TypeSolver getTypeSolver()

      • getLocation

        public java.lang.String getLocation​(com.github.javaparser.ast.Node node,
                                    int fallbackLine)

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException