org.jessma.util

类 PackageHelper

java.lang.Object

org.jessma.util.PackageHelper

public class PackageHelper
extends Object

包资源访问帮助类

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	PackageHelper.ClassFilter Java 类型过滤器接口
static class	PackageHelper.CompatibleTypeFilter 兼容类型过滤器（只接受与指定类型兼容的类型）
static class	PackageHelper.FileTypeFilter 文件类型过滤器（接受指定扩展名）
static class	PackageHelper.FileTypesFilter 文件类型过滤器（接受一组扩展名）
static interface	PackageHelper.PackageFilter 包过滤器接口
static class	PackageHelper.PatternFilter 正则表达式过滤器
static interface	PackageHelper.ResourceFilter 资源文件过滤器接口
static class	PackageHelper.TopLevelClassFileFilter 顶层 Java class 文件过滤器（只接受 '*.class' 类型文件，并且文件名不包含 '$' 符号）

构造器概要

构造器

构造器和说明
PackageHelper()

方法概要

方法

限定符和类型	方法和说明
static Set<Class<?>>	getClasses(String basePackage, boolean recursive) 获取包中某些类的 Class 对象集合（只获取顶层类）
static Set<Class<?>>	getClasses(String basePackage, boolean recursive, Class<?> compatibleType) 获取包中某些类的 Class 对象集合（只获取与 compatibleType 兼容的顶层类）
static Set<Class<?>>	getClasses(String basePackage, boolean recursive, PackageHelper.ClassFilter classFilter) 获取包中某些类的 Class 对象集合（只获取顶层类）
static Set<Class<?>>	getClasses(String basePackage, boolean recursive, PackageHelper.ClassFilter classFilter, PackageHelper.ResourceFilter resourceFilter) 获取包中某些类的 Class 对象集合
static Set<String>	getPackages(String pattern) 获取符合特定正则表达式的包名称集合（注：不扫描 jar 文件）
static Set<String>	getPackages(String basePackage, PackageHelper.PackageFilter filter) 获取包中符合过滤条件的子包名称集合
static Set<String>	getPackages(String basePackage, String pattern) 获取包中符合特定正则表达式的子包名称集合
static Set<String>	getResourceNames(String basePackagePath, boolean recursive) 获取包中所有资源文件的名称集合
static Set<String>	getResourceNames(String basePackagePath, boolean recursive, PackageHelper.ResourceFilter filter) 获取包中某些资源文件的名称集合
static void	scanPackageNamesByFile(String filePath, int packageStartIndex, PackageHelper.PackageFilter filter, Set<String> names) 在文件系统中扫描子包
static void	scanPackageNamesByFile(String filePath, int packageStartIndex, Set<String> names) 在文件系统中扫描子包
static void	scanPackageNamesByJar(URL url, String basePackagePath, PackageHelper.PackageFilter filter, Set<String> names) 在 jar 文件中扫描子包
static void	scanPackageNamesByJar(URL url, String basePackagePath, Set<String> names) 在 jar 文件中扫描子包
static void	scanResourceNamesByFile(String filePath, int packageStartIndex, boolean recursive, PackageHelper.ResourceFilter filter, Set<String> names) 在文件系统中扫描资源文件
static void	scanResourceNamesByFile(String filePath, int packageStartIndex, boolean recursive, Set<String> names) 在文件系统中扫描资源文件
static void	scanResourceNamesByJar(URL url, String basePackagePath, boolean recursive, PackageHelper.ResourceFilter filter, Set<String> names) 在 jar 文件中扫描资源文件
static void	scanResourceNamesByJar(URL url, String basePackagePath, boolean recursive, Set<String> names) 在 jar 文件中扫描资源文件

从类继承的方法 java.lang.Object

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

构造器详细资料

PackageHelper

public PackageHelper()

方法详细资料

getClasses

public static final Set<Class<?>> getClasses(String basePackage,
                       boolean recursive)

获取包中某些类的 Class 对象集合（只获取顶层类）

参数:

basePackage - : 包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

recursive - : 是否递归子包

返回:

符合条件的 Class 对象集合

getClasses

public static final Set<Class<?>> getClasses(String basePackage,
                       boolean recursive,
                       Class<?> compatibleType)

获取包中某些类的 Class 对象集合（只获取与 compatibleType 兼容的顶层类）

参数:

basePackage - : 包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

recursive - : 是否递归子包

compatibleType - : 兼容类型

返回:

符合条件的 Class 对象集合

getClasses

public static final Set<Class<?>> getClasses(String basePackage,
                       boolean recursive,
                       PackageHelper.ClassFilter classFilter)

获取包中某些类的 Class 对象集合（只获取顶层类）

参数:

basePackage - : 包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

recursive - : 是否递归子包

classFilter - : 类型过滤器，参考：PackageHelper.ClassFilter

返回:

符合条件的 Class 对象集合

getClasses

public static final Set<Class<?>> getClasses(String basePackage,
                       boolean recursive,
                       PackageHelper.ClassFilter classFilter,
                       PackageHelper.ResourceFilter resourceFilter)

获取包中某些类的 Class 对象集合

参数:

basePackage - : 包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

recursive - : 是否递归子包

classFilter - : 类型过滤器，参考：PackageHelper.ClassFilter

resourceFilter - : 资源文件过滤器，参考：PackageHelper.ResourceFilter

返回:

符合条件的 Class 对象集合

getResourceNames

public static final Set<String> getResourceNames(String basePackagePath,
                           boolean recursive)

获取包中所有资源文件的名称集合

参数:

basePackagePath - : 包路径

recursive - : 是否递归子目录

返回:

符合条件的资源名称集合

getResourceNames

public static final Set<String> getResourceNames(String basePackagePath,
                           boolean recursive,
                           PackageHelper.ResourceFilter filter)

获取包中某些资源文件的名称集合

参数:

basePackagePath - : 包路径

recursive - : 是否递归子目录

filter - : 资源文件过滤器，参考：PackageHelper.ResourceFilter

返回:

符合条件的资源名称集合

scanResourceNamesByFile

public static final void scanResourceNamesByFile(String filePath,
                           int packageStartIndex,
                           boolean recursive,
                           Set<String> names)

在文件系统中扫描资源文件

参数:

filePath - : 文件目录

packageStartIndex - : filePath 参数中包名称的起始位置

recursive - : 是否扫描子目录

names - : 扫描结果集合

scanResourceNamesByFile

public static final void scanResourceNamesByFile(String filePath,
                           int packageStartIndex,
                           boolean recursive,
                           PackageHelper.ResourceFilter filter,
                           Set<String> names)

在文件系统中扫描资源文件

参数:

filePath - : 文件目录

packageStartIndex - : filePath 参数中包名称的起始位置

recursive - : 是否扫描子目录

filter - : 资源文件过滤器，参考：PackageHelper.ResourceFilter

names - : 扫描结果集合

scanResourceNamesByJar

public static final void scanResourceNamesByJar(URL url,
                          String basePackagePath,
                          boolean recursive,
                          Set<String> names)

在 jar 文件中扫描资源文件

参数:

url - : jar 文件的 URL

basePackagePath - : jar 文件中的包路径

recursive - : 是否扫描子目录

names - : 扫描结果集合

scanResourceNamesByJar

public static final void scanResourceNamesByJar(URL url,
                          String basePackagePath,
                          boolean recursive,
                          PackageHelper.ResourceFilter filter,
                          Set<String> names)

在 jar 文件中扫描资源文件

参数:

url - : jar 文件的 URL

basePackagePath - : jar 文件中的包路径

recursive - : 是否扫描子目录

filter - : 资源文件过滤器，参考：PackageHelper.ResourceFilter

names - : 扫描结果集合

getPackages

public static final Set<String> getPackages(String pattern)

获取符合特定正则表达式的包名称集合（注：不扫描 jar 文件）

参数:

pattern - : 正则表达式，通过 PackageHelper.PatternFilter 进行过滤

返回:

符合条件的子包名称集合

getPackages

public static final Set<String> getPackages(String basePackage,
                      String pattern)

获取包中符合特定正则表达式的子包名称集合

参数:

basePackage - : 根包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

pattern - : 正则表达式，通过 PackageHelper.PatternFilter 进行过滤

返回:

符合条件的子包名称集合

getPackages

public static final Set<String> getPackages(String basePackage,
                      PackageHelper.PackageFilter filter)

获取包中符合过滤条件的子包名称集合

参数:

basePackage - : 根包名（注：如果 basePackage 为空字符串("")，则不扫描 jar 文件）

filter - : 包过滤器，如果为 null 则不过滤，参考：PackageHelper.PackageFilter

返回:

符合条件的子包名称集合

scanPackageNamesByFile

public static final void scanPackageNamesByFile(String filePath,
                          int packageStartIndex,
                          Set<String> names)

在文件系统中扫描子包

参数:

filePath - : 文件目录

packageStartIndex - : filePath 参数中包名称的起始位置

names - : 扫描结果集合

scanPackageNamesByFile

public static final void scanPackageNamesByFile(String filePath,
                          int packageStartIndex,
                          PackageHelper.PackageFilter filter,
                          Set<String> names)

在文件系统中扫描子包

参数:

filePath - : 文件目录

packageStartIndex - : filePath 参数中包名称的起始位置

filter - : 包过滤器，参考：PackageHelper.PackageFilter

names - : 扫描结果集合

scanPackageNamesByJar

public static final void scanPackageNamesByJar(URL url,
                         String basePackagePath,
                         Set<String> names)

在 jar 文件中扫描子包

参数:

url - : jar 文件的 URL

basePackagePath - : jar 文件中的包路径

names - : 扫描结果集合

scanPackageNamesByJar

public static final void scanPackageNamesByJar(URL url,
                         String basePackagePath,
                         PackageHelper.PackageFilter filter,
                         Set<String> names)

在 jar 文件中扫描子包

参数:

url - : jar 文件的 URL

basePackagePath - : jar 文件中的包路径

filter - : 包过滤器，参考：PackageHelper.PackageFilter

names - : 扫描结果集合