ClassScanner (jarvis-tool-core 1.0.3.RELEASE API)

java.lang.Object
- com.github.jarvisframework.tool.core.lang.ClassScanner

所有已实现的接口:

Serializable
```
public class ClassScanner
extends Object
implements Serializable
```
类扫描器

从以下版本开始:

1.0, 2020-07-29 19:34:31

作者:

Doug Wang

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`private Charset`	`charset` 编码
`private Set<Class<?>>`	`classes` 扫描结果集
`private Filter<Class<?>>`	`classFilter` 过滤器
`private ClassLoader`	`classLoader` 类加载器
`private boolean`	`initialize` 是否初始化类
`private String`	`packageDirName` 包路径，用于文件中对路径操作
`private String`	`packageName` 包名
`private String`	`packageNameWithDot` 包名，最后跟一个点，表示包名，避免在检查前缀时的歧义
`private String`	`packagePath` 包路径，用于jar中对路径操作，在Linux下与packageDirName一致
`private static long`	`serialVersionUID`

构造器概要

构造器
构造器和说明
`ClassScanner()` 构造，默认UTF-8编码
`ClassScanner(String packageName)` 构造，默认UTF-8编码
`ClassScanner(String packageName, Filter<Class<?>> classFilter)` 构造，默认UTF-8编码
`ClassScanner(String packageName, Filter<Class<?>> classFilter, Charset charset)` 构造

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`private void`	`addIfAccept(Class<?> clazz)` 通过过滤器，是否满足接受此类的条件
`private void`	`addIfAccept(String className)` 通过过滤器，是否满足接受此类的条件
`private Class<?>`	`loadClass(String className)` 加载类
`Set<Class<?>>`	`scan()` 扫描包路径下满足class过滤器条件的所有class文件
`private void`	`scanFile(File file, String rootDir)` 扫描文件或目录中的类
`private void`	`scanJar(JarFile jar)` 扫描jar包
`private void`	`scanJavaClassPaths()` 扫描Java指定的ClassPath路径
`static Set<Class<?>>`	`scanPackage()` 扫描该包路径下所有class文件
`static Set<Class<?>>`	`scanPackage(String packageName)` 扫描该包路径下所有class文件
`static Set<Class<?>>`	`scanPackage(String packageName, Filter<Class<?>> classFilter)` 扫描包路径下满足class过滤器条件的所有class文件，如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理
`static Set<Class<?>>`	`scanPackageByAnnotation(String packageName, Class<? extends Annotation> annotationClass)` 扫描指定包路径下所有包含指定注解的类
`static Set<Class<?>>`	`scanPackageBySuper(String packageName, Class<?> superClass)` 扫描指定包路径下所有指定类或接口的子类或实现类，不包括指定父类本身
`void`	`setClassLoader(ClassLoader classLoader)` 设置自定义的类加载器
`void`	`setInitialize(boolean initialize)` 设置是否在扫描到类时初始化类
`private String`	`subPathBeforePackage(File file)` 截取文件绝对路径中包名之前的部分

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - serialVersionUID
```
private static final long serialVersionUID
```
    另请参阅:
    
    常量字段值
  - packageName
```
private final String packageName
```
    包名
  - packageNameWithDot
```
private final String packageNameWithDot
```
    包名，最后跟一个点，表示包名，避免在检查前缀时的歧义
  - packageDirName
```
private final String packageDirName
```
    包路径，用于文件中对路径操作
  - packagePath
```
private final String packagePath
```
    包路径，用于jar中对路径操作，在Linux下与packageDirName一致
  - classFilter
```
private final Filter<Class<?>> classFilter
```
    过滤器
  - charset
```
private final Charset charset
```
    编码
  - classLoader
```
private ClassLoader classLoader
```
    类加载器
  - initialize
```
private boolean initialize
```
    是否初始化类
  - classes
```
private final Set<Class<?>> classes
```
    扫描结果集
- 构造器详细资料
  - ClassScanner
```
public ClassScanner()
```
    构造，默认UTF-8编码
  - ClassScanner
```
public ClassScanner(String packageName)
```
    构造，默认UTF-8编码
    
    参数:
    
    packageName - 包名，所有包传入""或者null
  - ClassScanner
```
public ClassScanner(String packageName,
                    Filter<Class<?>> classFilter)
```
    构造，默认UTF-8编码
    
    参数:
    
    packageName - 包名，所有包传入""或者null
    
    classFilter - 过滤器，无需传入null
  - ClassScanner
```
public ClassScanner(String packageName,
                    Filter<Class<?>> classFilter,
                    Charset charset)
```
    构造
    
    参数:
    
    packageName - 包名，所有包传入""或者null
    
    classFilter - 过滤器，无需传入null
    
    charset - 编码
- 方法详细资料
  - scanPackageByAnnotation
```
public static Set<Class<?>> scanPackageByAnnotation(String packageName,
                                                    Class<? extends Annotation> annotationClass)
```
    扫描指定包路径下所有包含指定注解的类
    
    参数:
    
    packageName - 包路径
    
    annotationClass - 注解类
    
    返回:
    
    类集合
  - scanPackageBySuper
```
public static Set<Class<?>> scanPackageBySuper(String packageName,
                                               Class<?> superClass)
```
    扫描指定包路径下所有指定类或接口的子类或实现类，不包括指定父类本身
    
    参数:
    
    packageName - 包路径
    
    superClass - 父类或接口（不包括）
    
    返回:
    
    类集合
  - scanPackage
```
public static Set<Class<?>> scanPackage()
```
    扫描该包路径下所有class文件
    
    返回:
    
    类集合
  - scanPackage
```
public static Set<Class<?>> scanPackage(String packageName)
```
    扫描该包路径下所有class文件
    
    参数:
    
    packageName - 包路径 com | com. | com.abs | com.abs.
    
    返回:
    
    类集合
  - scanPackage
```
public static Set<Class<?>> scanPackage(String packageName,
                                        Filter<Class<?>> classFilter)
```
    扫描包路径下满足class过滤器条件的所有class文件，
    如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
    因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理
    
    参数:
    
    packageName - 包路径 com | com. | com.abs | com.abs.
    
    classFilter - class过滤器，过滤掉不需要的class
    
    返回:
    
    类集合
  - scan
```
public Set<Class<?>> scan()
```
    扫描包路径下满足class过滤器条件的所有class文件
    
    返回:
    
    类集合
  - setInitialize
```
public void setInitialize(boolean initialize)
```
    设置是否在扫描到类时初始化类
    
    参数:
    
    initialize - 是否初始化类
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    设置自定义的类加载器
    
    参数:
    
    classLoader - 类加载器
    
    从以下版本开始:
    
    4.6.9
  - scanJavaClassPaths
```
private void scanJavaClassPaths()
```
    扫描Java指定的ClassPath路径
  - scanFile
```
private void scanFile(File file,
                      String rootDir)
```
    扫描文件或目录中的类
    
    参数:
    
    file - 文件或目录
    
    rootDir - 包名对应classpath绝对路径
  - scanJar
```
private void scanJar(JarFile jar)
```
    扫描jar包
    
    参数:
    
    jar - jar包
  - loadClass
```
private Class<?> loadClass(String className)
```
    加载类
    
    参数:
    
    className - 类名
    
    返回:
    
    加载的类
  - addIfAccept
```
private void addIfAccept(String className)
```
    通过过滤器，是否满足接受此类的条件
    
    参数:
    
    className - 类名
  - addIfAccept
```
private void addIfAccept(Class<?> clazz)
```
    通过过滤器，是否满足接受此类的条件
    
    参数:
    
    clazz - 类
  - subPathBeforePackage
```
private String subPathBeforePackage(File file)
```
    截取文件绝对路径中包名之前的部分
    
    参数:
    
    file - 文件
    
    返回:
    
    包名之前的部分

类 ClassScanner

字段概要

构造器概要

方法概要

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

字段详细资料

serialVersionUID

packageName

packageNameWithDot

packageDirName

packagePath

classFilter

charset

classLoader

initialize

classes

构造器详细资料

ClassScanner

ClassScanner

ClassScanner

ClassScanner

方法详细资料

scanPackageByAnnotation

scanPackageBySuper

scanPackage

scanPackage

scanPackage

scan

setInitialize

setClassLoader

scanJavaClassPaths

scanFile

scanJar

loadClass

addIfAccept

addIfAccept

subPathBeforePackage