Class JavadocTool.PackageTable

  • Enclosing class:
    JavadocTool

    class JavadocTool.PackageTable
    extends java.lang.Object
    A table to manage included and excluded packages.
    • Constructor Summary

      Constructors 
      Constructor Description
      PackageTable​(javax.tools.JavaFileManager fm, javax.tools.JavaFileManager.Location locn)
      Creates a table to manage included and excluded packages.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private JavadocTool.PackageTable.Entry getEntry​(java.lang.String name)  
      (package private) com.sun.tools.javac.util.List<javax.tools.JavaFileObject> getFiles​(java.lang.String packageName)
      Returns the set of source files for a package.
      (package private) java.util.Set<java.lang.String> getIncludedPackages()
      Returns the aggregate set of included packages.
      private javax.tools.JavaFileManager.Location getLocation​(java.lang.String packageName)  
      private java.lang.String getPackageName​(java.lang.String name)  
      private java.lang.String getSimpleName​(java.lang.String name)  
      (package private) JavadocTool.PackageTable packages​(java.util.Collection<java.lang.String> packageNames)  
      (package private) JavadocTool.PackageTable subpackages​(java.util.Collection<java.lang.String> packageNames, java.util.Collection<java.lang.String> excludePackageNames)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • includedPackages

        private final java.util.Set<java.lang.String> includedPackages
      • fm

        private final javax.tools.JavaFileManager fm
      • location

        private final javax.tools.JavaFileManager.Location location
      • sourceKinds

        private final java.util.Set<javax.tools.JavaFileObject.Kind> sourceKinds
    • Constructor Detail

      • PackageTable

        PackageTable​(javax.tools.JavaFileManager fm,
                     javax.tools.JavaFileManager.Location locn)
        Creates a table to manage included and excluded packages.
        Parameters:
        fm - The file manager used to locate source files
        locn - the location used to locate source files
    • Method Detail

      • subpackages

        JavadocTool.PackageTable subpackages​(java.util.Collection<java.lang.String> packageNames,
                                             java.util.Collection<java.lang.String> excludePackageNames)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • getIncludedPackages

        java.util.Set<java.lang.String> getIncludedPackages()
        Returns the aggregate set of included packages.
        Returns:
        the aggregate set of included packages
      • getFiles

        com.sun.tools.javac.util.List<javax.tools.JavaFileObject> getFiles​(java.lang.String packageName)
                                                                    throws java.io.IOException
        Returns the set of source files for a package.
        Parameters:
        packageName - the specified package
        Returns:
        the set of file objects for the specified package
        Throws:
        java.io.IOException - if an error occurs while accessing the files
      • getLocation

        private javax.tools.JavaFileManager.Location getLocation​(java.lang.String packageName)
                                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • getPackageName

        private java.lang.String getPackageName​(java.lang.String name)
      • getSimpleName

        private java.lang.String getSimpleName​(java.lang.String name)