blade.kit

类 ClassKit

java.lang.Object

blade.kit.ClassKit

public abstract class ClassKit
extends Object

有关 Class 处理的工具类。

这个类中的每个方法都可以“安全”地处理 null ，而不会抛出 NullPointerException。

从以下版本开始:

1.0

作者:

biezhi

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	ClassKit.TypeInfo 代表一个类的信息, 包括父类, 接口, 数组的维数等.

字段概要

字段

限定符和类型	字段和说明
static String	INNER_CLASS_SEPARATOR 内联类的分隔符： "$"。
static char	INNER_CLASS_SEPARATOR_CHAR 内联类的分隔符： '$'。

构造器概要

构造器

构造器和说明
ClassKit()

方法概要

限定符和类型	方法和说明
static <T> boolean	canInstatnce(Class<T> clazz) 判断一个类是否可以实例化，如果clazz为null，则返回false 按一下顺序判断： 如果clazz为primitive类型，我们认为除了 void.class外，其他都可实例化，因为可以直接赋值 如果clazz为Array类型，如果数组元素的类型为public ，那么显然也可以实例化，因为可以直接定义新对象，返还 true 接下来看clazz是否为abstract或 interface ，如果是，则显然不可实例化，返还false 最后遍历clazz的构造器，查看是否存在public类型接口，如果存在则返还 true，否则返还false
static List<Class<?>>	getAllInterfaces(Class<?> clazz)
static Class<?>[]	getAllInterfacesAsArray(Class<?> clazz)
static Set<Class<?>>	getAllInterfacesAsSet(Class<?> clazz, ClassLoader classLoader)
static List<Class<?>>	getAllSuperclasses(Class<?> clazz) 获取除Object.class以为的所有父类
static Class<?>[]	getAllSuperclassesAsArray(Class<?> clazz)
static Class<?>	getArrayClass(Class<?> componentType) 取得指定一维数组类.
static Class<?>	getArrayClass(Class<?> componentClass, int dimension) 取得指定维数的 Array类.
static Class<?>	getArrayComponentType(Class<?> type) 取得数组元素的类型。
static String	getClassNameAsResource(String className) 取得指定类的资源名。
static String	getFriendlyClassName(Class<?> clazz) 取得友好的类名。
static String	getFriendlyClassName(String javaClassName) 取得友好的类名。
static String	getFriendlyClassNameForObject(Object object) 取得对象所属的类的友好类名。
static <T> T	getPrimitiveDefaultValue(Class<T> type) 取得primitive类型的默认值。
static Class<?>	getPrimitiveType(Class<?> type) 取得primitive类。
static Class<?>	getPrimitiveType(String name) 取得primitive类。
static String	getShortClassName(Class<?> clazz) 取得短类名，不包括package名。
static String	getShortClassName(String className) 取得类名，不包括package名。
static String	getSimpleClassName(Class<?> clazz) 取得简单类名，不包括package名。
static String	getSimpleClassName(Class<?> clazz, boolean proccessInnerClass) 取得简单类名，不包括package名。
static String	getSimpleClassName(String javaClassName) 取得类名，不包括package名。
static String	getSimpleClassName(String javaClassName, boolean proccesInnerClass) 取得类名，不包括package名。
static String	getSimpleClassNameForObject(Object object) 取得指定对象所属的类的简单类名，不包括package名。
static String	getSimpleClassNameForObject(Object object, boolean processInnerClass) 取得指定对象所属的类的简单类名，不包括package名。
static String	getSimpleMethodSignature(Method method) 取得简洁的method描述。
static String	getSimpleMethodSignature(Method method, boolean withClassName) 取得简洁的method描述。
static String	getSimpleMethodSignature(Method method, boolean withModifiers, boolean withReturnType, boolean withClassName, boolean withExceptionType) 取得简洁的method描述。
protected static ClassKit.TypeInfo	getTypeInfo(Class<?> type) 取得指定类的 TypeInfo。
static <T> Class<T>	getWrapperTypeIfPrimitive(Class<T> type) 取得primitive类型的wrapper。
static boolean	isAssignable(Class<?>[] classes, Class<?>[] fromClasses) 检查一组指定类型 fromClasses 的对象是否可以赋值给另一组类型 classes。
static boolean	isAssignable(Class<?> clazz, Class<?> fromClass) 检查指定类型 fromClass 的对象是否可以赋值给另一种类型 clazz。
static boolean	isCacheSafe(Class<?> clazz, ClassLoader classLoader)
static boolean	isInstance(Class<?> clazz, Object object) 如果对象object是类clazz的实例， 则返回true，否则返回 false 此方法考虑包装类和基本类型的转换 ClassUtil.isInstance(int.class, Integer.valueOf(0)) = true; ClassUtil.isInstance(Integer.class, (int) 0) = true; ClassUtil.isInstance(int.class, (int) 0) = true; ClassUtil.isInstance(Integer.class, Integer.valueOf(0)) = true; ClassUtil.isInstance(int[].class, new Integer[] { 0 }) = false; ClassUtil.isInstance(Integer[].class, new int[] { 0 }) = false; ClassUtil.isInstance(int[].class, new new int[] { 0 }) = false; ClassUtil.isInstance(Integer[].class, new Integer[] { 0 }) = false;
static boolean	isInterfaceImpl(Class<?> thisClass, Class<?> targetInterface)
static boolean	isPrimitiveOrWrapper(Class<?> clazz) 判断是否为原子类型或者其包装类，如果clazz为null，则返还 false
static boolean	isSubClass(Class<?> thisClass, Class<?> target)
static boolean	isVisible(Class<?> clazz, ClassLoader classLoader)
static String	locateClass(Class<?> clazz) 在class loader中查找class的位置。
static String	locateClass(String className) 在class loader中查找class的位置。
static String	locateClass(String className, ClassLoader loader) 在class loader中查找class的位置。

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

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

字段详细资料

INNER_CLASS_SEPARATOR_CHAR

public static final char INNER_CLASS_SEPARATOR_CHAR

内联类的分隔符： '$'。

另请参阅:

常量字段值

INNER_CLASS_SEPARATOR

public static final String INNER_CLASS_SEPARATOR

内联类的分隔符： "$"。

构造器详细资料

ClassKit

public ClassKit()

方法详细资料

getClassNameAsResource

public static String getClassNameAsResource(String className)

取得指定类的资源名。

例如：

 ClassUtil.getClassNameAsResource("java.lang.String") = "java/lang/String.class"
 

参数:

className - 要显示的类名

返回:

指定类名对应的资源名，如果指定类名为空，则返回null

getPrimitiveType

public static Class<?> getPrimitiveType(String name)

取得primitive类。

例如：

 ClassUtil.getPrimitiveType("int") = int.class;
 ClassUtil.getPrimitiveType("long") = long.class;
 

getPrimitiveType

public static Class<?> getPrimitiveType(Class<?> type)

取得primitive类。

例如：

 ClassUtil.getPrimitiveType(Integer.class) = int.class;
 ClassUtil.getPrimitiveType(Long.class) = long.class;
 

getWrapperTypeIfPrimitive

public static <T> Class<T> getWrapperTypeIfPrimitive(Class<T> type)

取得primitive类型的wrapper。如果不是primitive，则原样返回。

如果clazz为null，则返还 null

例如：

 ClassUtil.getPrimitiveWrapperType(int.class) = Integer.class;
 ClassUtil.getPrimitiveWrapperType(int[].class) = int[].class;
 ClassUtil.getPrimitiveWrapperType(int[][].class) = int[][].class;
 ClassUtil.getPrimitiveWrapperType(String[][].class) = String[][].class;
 

getPrimitiveDefaultValue

public static <T> T getPrimitiveDefaultValue(Class<T> type)

取得primitive类型的默认值。如果不是primitive，则返回null。

如果clazz为null，则返还 null

例如：

 ClassUtil.getPrimitiveDefaultValue(int.class) = 0;
 ClassUtil.getPrimitiveDefaultValue(boolean.class) = false;
 ClassUtil.getPrimitiveDefaultValue(char.class) = '\0';
 

isPrimitiveOrWrapper

public static boolean isPrimitiveOrWrapper(Class<?> clazz)

判断是否为原子类型或者其包装类，如果clazz为null，则返还 false

getArrayClass

public static Class<?> getArrayClass(Class<?> componentType)

取得指定一维数组类.

参数:

componentType - 数组的基础类

返回:

数组类，如果数组的基类为 null ，则返回 null

getArrayClass

public static Class<?> getArrayClass(Class<?> componentClass,
                                     int dimension)

取得指定维数的 Array类.

参数:

componentType - 数组的基类

dimension - 维数，如果小于 0 则看作 0

返回:

如果维数为0, 则返回基类本身, 否则返回数组类，如果数组的基类为 null ，则返回 null

getArrayComponentType

public static Class<?> getArrayComponentType(Class<?> type)

取得数组元素的类型。

参数:

type - 要查找的类

返回:

如果是数组, 则返回数组元素的类型, 否则返回 null

isInstance

public static boolean isInstance(Class<?> clazz,
                                 Object object)

如果对象object是类clazz的实例， 则返回true，否则返回 false

此方法考虑包装类和基本类型的转换

 ClassUtil.isInstance(int.class, Integer.valueOf(0)) = true;
 ClassUtil.isInstance(Integer.class, (int) 0) = true;
 ClassUtil.isInstance(int.class, (int) 0) = true;
 ClassUtil.isInstance(Integer.class, Integer.valueOf(0)) = true;
 ClassUtil.isInstance(int[].class, new Integer[] { 0 }) = false;
 ClassUtil.isInstance(Integer[].class, new int[] { 0 }) = false;
 ClassUtil.isInstance(int[].class, new new int[] { 0 }) = false;
 ClassUtil.isInstance(Integer[].class, new Integer[] { 0 }) = false;
 

参数:

clazz - 校验的类

object - 校验的对象

返回:

是否匹配，如果clazz或者object为null ，则返回false

canInstatnce

public static <T> boolean canInstatnce(Class<T> clazz)

判断一个类是否可以实例化，如果clazz为null，则返回false

按一下顺序判断：

如果clazz为primitive类型，我们认为除了 void.class外，其他都可实例化，因为可以直接赋值 如果clazz为Array类型，如果数组元素的类型为public ，那么显然也可以实例化，因为可以直接定义新对象，返还 true 接下来看clazz是否为abstract或 interface ，如果是，则显然不可实例化，返还false 最后遍历clazz的构造器，查看是否存在public类型接口，如果存在则返还 true，否则返还false

参数:

clazz - 校验的类

返回:

如果可以实例化则返回true，否则返回false

getTypeInfo

protected static ClassKit.TypeInfo getTypeInfo(Class<?> type)

取得指定类的 TypeInfo。

参数:

type - 指定类或接口

返回:

TypeInfo 对象.

getAllSuperclasses

public static List<Class<?>> getAllSuperclasses(Class<?> clazz)

获取除Object.class以为的所有父类

getAllSuperclassesAsArray

public static Class<?>[] getAllSuperclassesAsArray(Class<?> clazz)

getAllInterfaces

public static List<Class<?>> getAllInterfaces(Class<?> clazz)

getAllInterfacesAsArray

public static Class<?>[] getAllInterfacesAsArray(Class<?> clazz)

getAllInterfacesAsSet

public static Set<Class<?>> getAllInterfacesAsSet(Class<?> clazz,
                                                  ClassLoader classLoader)

isVisible

public static boolean isVisible(Class<?> clazz,
                                ClassLoader classLoader)

isCacheSafe

public static boolean isCacheSafe(Class<?> clazz,
                                  ClassLoader classLoader)

isInterfaceImpl

public static boolean isInterfaceImpl(Class<?> thisClass,
                                      Class<?> targetInterface)

isSubClass

public static boolean isSubClass(Class<?> thisClass,
                                 Class<?> target)

isAssignable

public static boolean isAssignable(Class<?>[] classes,
                                   Class<?>[] fromClasses)

检查一组指定类型 fromClasses 的对象是否可以赋值给另一组类型 classes。

此方法可以用来确定指定类型的参数 object1, object2, ... 是否可以用来调用确定参数类型为 class1, class2, ... 的方法。

对于 fromClasses 的每个元素 fromClass 和 classes 的每个元素 clazz， 按照如下规则：

1. 如果目标类 clazz 为 null ，总是返回 false 。
2. 如果参数类型 fromClass 为 null ，并且目标类型 clazz 为非原子类型，则返回 true。 因为 null 可以被赋给任何引用类型。
3. 调用 Class.isAssignableFrom 方法来确定目标类 clazz 是否和参数类 fromClass 相同或是其父类、接口，如果是，则返回 true。
4. 如果目标类型 clazz 为原子类型，那么根据 The Java Language Specification ，sections 5.1.1, 5.1.2, 5.1.4定义的Widening Primitive Conversion规则，参数类型 fromClass 可以是任何能扩展成该目标类型的原子类型及其包装类。 例如， clazz 为 long ，那么参数类型可以是 byte、 short、int、long、char 及其包装类 java.lang.Byte、 java.lang.Short、 java.lang.Integer、 java.lang.Long 和 java.lang.Character 。如果满足这个条件，则返回 true。
5. 不满足上述所有条件，则返回 false。

参数:

classes - 目标类型列表，如果是 null 总是返回 false

fromClasses - 参数类型列表， null 表示可赋值给任意非原子类型

返回:

如果可以被赋值，则返回 true

isAssignable

public static boolean isAssignable(Class<?> clazz,
                                   Class<?> fromClass)

检查指定类型 fromClass 的对象是否可以赋值给另一种类型 clazz。

此方法可以用来确定指定类型的参数 object1, object2, ... 是否可以用来调用确定参数类型 class1, class2, ... 的方法。

按照如下规则：

1. 如果目标类 clazz 为 null ，总是返回 false 。
2. 如果参数类型 fromClass 为 null ，并且目标类型 clazz 为非原子类型，则返回 true。 因为 null 可以被赋给任何引用类型。
3. 调用 Class.isAssignableFrom 方法来确定目标类 clazz 是否和参数类 fromClass 相同或是其父类、接口，如果是，则返回 true。
4. 如果目标类型 clazz 为原子类型，那么根据 The Java Language Specification ，sections 5.1.1, 5.1.2, 5.1.4定义的Widening Primitive Conversion规则，参数类型 fromClass 可以是任何能扩展成该目标类型的原子类型及其包装类。 例如， clazz 为 long ，那么参数类型可以是 byte、 short、int、long、char 及其包装类 java.lang.Byte、 java.lang.Short、 java.lang.Integer、 java.lang.Long 和 java.lang.Character 。如果满足这个条件，则返回 true。
5. 不满足上述所有条件，则返回 false。

参数:

clazz - 目标类型，如果是 null 总是返回 false

fromClass - 参数类型， null 表示可赋值给任意非原子类型

返回:

如果可以被赋值，则返回 null

locateClass

public static String locateClass(Class<?> clazz)

在class loader中查找class的位置。

locateClass

public static String locateClass(String className)

在class loader中查找class的位置。

locateClass

public static String locateClass(String className,
                                 ClassLoader loader)

在class loader中查找class的位置。

getFriendlyClassNameForObject

public static String getFriendlyClassNameForObject(Object object)

取得对象所属的类的友好类名。

类似object.getClass().getName()，但不同的是，该方法用更友好的方式显示数组类型。 例如：

  int[].class.getName() = "[I"
  ClassUtil.getFriendlyClassName(int[].class) = "int[]"
 
  Integer[][].class.getName() = "[[Ljava.lang.Integer;"
  ClassUtil.getFriendlyClassName(Integer[][].class) = "java.lang.Integer[][]"
 

对于非数组的类型，该方法等效于 Class.getName() 方法。

注意，该方法所返回的数组类名只能用于显示给人看，不能用于 Class.forName 操作。

参数:

object - 要显示类名的对象

返回:

用于显示的友好类名，如果对象为空，则返回null

getFriendlyClassName

public static String getFriendlyClassName(Class<?> clazz)

取得友好的类名。

类似clazz.getName()，但不同的是，该方法用更友好的方式显示数组类型。 例如：

  int[].class.getName() = "[I"
  ClassUtil.getFriendlyClassName(int[].class) = "int[]"
 
  Integer[][].class.getName() = "[[Ljava.lang.Integer;"
  ClassUtil.getFriendlyClassName(Integer[][].class) = "java.lang.Integer[][]"
 

对于非数组的类型，该方法等效于 Class.getName() 方法。

注意，该方法所返回的数组类名只能用于显示给人看，不能用于 Class.forName 操作。

参数:

object - 要显示类名的对象

返回:

用于显示的友好类名，如果类对象为空，则返回null

getFriendlyClassName

public static String getFriendlyClassName(String javaClassName)

取得友好的类名。

className 必须是从 clazz.getName() 所返回的合法类名。该方法用更友好的方式显示数组类型。 例如：

  int[].class.getName() = "[I"
  ClassUtil.getFriendlyClassName(int[].class) = "int[]"
 
  Integer[][].class.getName() = "[[Ljava.lang.Integer;"
  ClassUtil.getFriendlyClassName(Integer[][].class) = "java.lang.Integer[][]"
 

对于非数组的类型，该方法等效于 Class.getName() 方法。

注意，该方法所返回的数组类名只能用于显示给人看，不能用于 Class.forName 操作。

参数:

javaClassName - 要转换的类名

返回:

用于显示的友好类名，如果原类名为空，则返回 null ，如果原类名是非法的，则返回原类名

getSimpleClassNameForObject

public static String getSimpleClassNameForObject(Object object)

取得指定对象所属的类的简单类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassNameForObject(Boolean.TRUE) = "Boolean"
  ClassUtil.getSimpleClassNameForObject(new Boolean[10]) = "Boolean[]"
  ClassUtil.getSimpleClassNameForObject(new int[1][2]) = "int[][]"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

object - 要查看的对象

返回:

简单类名，如果对象为 null ，则返回 null

getSimpleClassNameForObject

public static String getSimpleClassNameForObject(Object object,
                                                 boolean processInnerClass)

取得指定对象所属的类的简单类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassNameForObject(Boolean.TRUE) = "Boolean"
  ClassUtil.getSimpleClassNameForObject(new Boolean[10]) = "Boolean[]"
  ClassUtil.getSimpleClassNameForObject(new int[1][2]) = "int[][]"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

object - 要查看的对象

返回:

简单类名，如果对象为 null ，则返回 null

getSimpleClassName

public static String getSimpleClassName(Class<?> clazz)

取得简单类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassName(Boolean.class) = "Boolean"
  ClassUtil.getSimpleClassName(Boolean[].class) = "Boolean[]"
  ClassUtil.getSimpleClassName(int[][].class) = "int[][]"
  ClassUtil.getSimpleClassName(Map.Entry.class) = "Map.Entry"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

clazz - 要查看的类

返回:

简单类名，如果类为 null ，则返回 null

getSimpleClassName

public static String getSimpleClassName(Class<?> clazz,
                                        boolean proccessInnerClass)

取得简单类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassName(Boolean.class) = "Boolean"
  ClassUtil.getSimpleClassName(Boolean[].class) = "Boolean[]"
  ClassUtil.getSimpleClassName(int[][].class) = "int[][]"
  ClassUtil.getSimpleClassName(Map.Entry.class) = "Map.Entry"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

clazz - 要查看的类

返回:

简单类名，如果类为 null ，则返回 null

getSimpleClassName

public static String getSimpleClassName(String javaClassName)

取得类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassName(Boolean.class.getName()) = "Boolean"
  ClassUtil.getSimpleClassName(Boolean[].class.getName()) = "Boolean[]"
  ClassUtil.getSimpleClassName(int[][].class.getName()) = "int[][]"
  ClassUtil.getSimpleClassName(Map.Entry.class.getName()) = "Map.Entry"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

javaClassName - 要查看的类名

返回:

简单类名，如果类名为空，则返回 null

getSimpleClassName

public static String getSimpleClassName(String javaClassName,
                                        boolean proccesInnerClass)

取得类名，不包括package名。

此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getSimpleClassName(Boolean.class.getName()) = "Boolean"
  ClassUtil.getSimpleClassName(Boolean[].class.getName()) = "Boolean[]"
  ClassUtil.getSimpleClassName(int[][].class.getName()) = "int[][]"
  ClassUtil.getSimpleClassName(Map.Entry.class.getName()) = "Map.Entry"
 

本方法和Class.getSimpleName()的区别在于，本方法会保留inner类的外层类名称。

参数:

javaClassName - 要查看的类名

返回:

简单类名，如果类名为空，则返回 null

getSimpleMethodSignature

public static String getSimpleMethodSignature(Method method)

取得简洁的method描述。

getSimpleMethodSignature

public static String getSimpleMethodSignature(Method method,
                                              boolean withClassName)

取得简洁的method描述。

getSimpleMethodSignature

public static String getSimpleMethodSignature(Method method,
                                              boolean withModifiers,
                                              boolean withReturnType,
                                              boolean withClassName,
                                              boolean withExceptionType)

取得简洁的method描述。

getShortClassName

public static String getShortClassName(String className)

取得类名，不包括package名。

此方法可以正确显示数组和内联类的名称。

例如：

  ClassUtil.getShortClassName(Boolean.class.getName()) = "Boolean" ClassUtil.getShortClassName(Boolean[].class.getName()) = "Boolean[]" ClassUtil.getShortClassName(int[][].class.getName()) = "int[][]" ClassUtil.getShortClassName(Map.Entry.class.getName()) = "Map.Entry"
 

参数:

className - 要查看的类名

返回:

短类名，如果类名为空，则返回 null

getShortClassName

public static String getShortClassName(Class<?> clazz)

取得短类名，不包括package名。 此方法可以正确显示数组和内联类的名称。 例如：

  ClassUtil.getShortClassName(Boolean.class) = "Boolean" ClassUtil.getShortClassName(Boolean[].class) = "Boolean[]" ClassUtil.getShortClassName(int[][].class) = "int[][]" ClassUtil.getShortClassName(Map.Entry.class) = "Map.Entry"
 

参数:

clazz - 要查看的类

返回:

短类名，如果类为 null ，则返回 null