com.landawn.abacus.util

Class ClassUtil

java.lang.Object

com.landawn.abacus.util.ClassUtil

public final class ClassUtil
extends java.lang.Object

Since:

0.9

Author:

Haiyang Li

Method Summary

Modifier and Type	Method and Description
static <T> java.lang.Class<T>	forClass(java.lang.String clsName) Supports primitive types: boolean, char, byte, short, int, long, float, double.
static java.lang.String	formalizePropName(java.lang.String propName) It's designed for field/method/class/column/table names.
static java.util.Set<java.lang.Class<?>>	getAllInterfaces(java.lang.Class<?> cls) Copied from Apache Commons Lang under Apache License v2.
static java.util.List<java.lang.Class<?>>	getAllSuperclasses(java.lang.Class<?> cls) Copied from Apache Commons Lang under Apache License v2.
static java.util.Set<java.lang.Class<?>>	getAllSuperTypes(java.lang.Class<?> cls) Returns all the interfaces and super classes the specified class implements or extends, excluding Object.class.
static java.lang.String	getCanonicalClassName(java.lang.Class<?> cls)
static java.util.List<java.lang.Class<?>>	getClassesByPackage(java.lang.String pkgName, boolean isRecursive, boolean skipClassLoaddingException)
static <E extends java.lang.Exception> java.util.List<java.lang.Class<?>>	getClassesByPackage(java.lang.String pkgName, boolean isRecursive, boolean skipClassLoaddingException, Try.Predicate<? super java.lang.Class<?>,E> predicate)
static java.lang.String	getClassName(java.lang.Class<?> cls)
static <T> java.lang.reflect.Constructor<T>	getDeclaredConstructor(java.lang.Class<T> cls, java.lang.Class<?>... parameterTypes) Returns the constructor declared in the specified cls with the specified parameterTypes.
static java.lang.reflect.Method	getDeclaredMethod(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... parameterTypes) Returns the method declared in the specified cls with the specified methodName and parameterTypes.
static java.lang.Class<?>	getEnclosingClass(java.lang.Class<?> cls)
static java.lang.Package	getPackage(java.lang.Class<?> cls)
static java.lang.String	getPackageName(java.lang.Class<?> cls)
static java.lang.String	getParameterizedTypeNameByMethod(java.lang.reflect.Method method)
static java.lang.reflect.Field	getPropField(java.lang.Class<?> cls, java.lang.String propName)
static java.lang.reflect.Method	getPropGetMethod(java.lang.Class<?> cls, java.lang.String propName) Returns the property get method declared in the specified cls with the specified property name propName.
static java.util.Map<java.lang.String,java.lang.reflect.Method>	getPropGetMethodList(java.lang.Class<?> cls) Call registerXMLBindingClassForPropGetSetMethod first to retrieve the property getter/setter method for the class/bean generated/wrote by JAXB specificatio
static java.lang.String	getPropNameByMethod(java.lang.reflect.Method getSetMethod)
static java.util.List<java.lang.String>	getPropNameList(java.lang.Class<?> cls) Returns an immutable entity property name List by the specified class.
static java.util.List<java.lang.String>	getPropNameListExclusively(java.lang.Class<?> cls, java.util.Collection<java.lang.String> propNameToExcluded)
static java.util.List<java.lang.String>	getPropNameListExclusively(java.lang.Class<?> cls, java.util.Set<java.lang.String> propNameToExcluded)
static java.lang.reflect.Method	getPropSetMethod(java.lang.Class<?> cls, java.lang.String propName) Returns the property set method declared in the specified cls with the specified property name propName.
static java.util.Map<java.lang.String,java.lang.reflect.Method>	getPropSetMethodList(java.lang.Class<?> cls)
static <T> T	getPropValue(java.lang.Object entity, java.lang.reflect.Method propGetMethod) Return the specified propValue got by the specified method propSetMethod in the specified entity.
static <T> T	getPropValue(java.lang.Object entity, java.lang.String propName) Refer to getPropValue(Method, Object)
static <T> T	getPropValue(java.lang.Object entity, java.lang.String propName, boolean ignoreUnknownProperty)
static java.lang.String	getSimpleClassName(java.lang.Class<?> cls)
static java.lang.Class<?>[]	getTypeArgumentsByMethod(java.lang.reflect.Method method)
static <T> T	invokeConstructor(java.lang.reflect.Constructor<T> constructor, java.lang.Object... args)
static <T> T	invokeMethod(java.lang.reflect.Method method, java.lang.Object... args)
static <T> T	invokeMethod(java.lang.Object instance, java.lang.reflect.Method method, java.lang.Object... args)
static void	registerNonEntityClass(java.lang.Class<?> cls)
static void	registerNonPropGetSetMethod(java.lang.Class<?> cls, java.lang.String propName)
static void	registerPropGetSetMethod(java.lang.String propName, java.lang.reflect.Method method)
static void	registerXMLBindingClassForPropGetSetMethod(java.lang.Class<?> cls) The property maybe only has get method if its type is collection or map by xml binding specificatio Otherwise, it will be ignored if not registered by calling this method.
static void	setPropValue(java.lang.Object entity, java.lang.reflect.Method propSetMethod, java.lang.Object propValue) Set the specified propValue to entity by the specified method propSetMethod.
static void	setPropValue(java.lang.Object entity, java.lang.String propName, java.lang.Object propValue) Refer to setPropValue(Method, Object, Object).
static boolean	setPropValue(java.lang.Object entity, java.lang.String propName, java.lang.Object propValue, boolean ignoreUnknownProperty)
static void	setPropValueByGet(java.lang.Object entity, java.lang.reflect.Method propGetMethod, java.lang.Object propValue)
static void	toLowerCaseKeyWithUnderscore(java.util.Map<java.lang.String,java.lang.Object> props)
static java.lang.String	toLowerCaseWithUnderscore(java.lang.String str) It's designed for field/method/class/column/table names.
static void	toUpperCaseKeyWithUnderscore(java.util.Map<java.lang.String,java.lang.Object> props)
static java.lang.String	toUpperCaseWithUnderscore(java.lang.String str) It's designed for field/method/class/column/table names.

Methods inherited from class java.lang.Object

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

Method Detail

registerXMLBindingClassForPropGetSetMethod

public static void registerXMLBindingClassForPropGetSetMethod(java.lang.Class<?> cls)

The property maybe only has get method if its type is collection or map by xml binding specificatio Otherwise, it will be ignored if not registered by calling this method.

Parameters:

cls -

registerNonEntityClass

public static void registerNonEntityClass(java.lang.Class<?> cls)

registerNonPropGetSetMethod

public static void registerNonPropGetSetMethod(java.lang.Class<?> cls,
                                               java.lang.String propName)

registerPropGetSetMethod

public static void registerPropGetSetMethod(java.lang.String propName,
                                            java.lang.reflect.Method method)

forClass

public static <T> java.lang.Class<T> forClass(java.lang.String clsName)
                                       throws java.lang.IllegalArgumentException

Supports primitive types: boolean, char, byte, short, int, long, float, double. And array type with format java.lang.String[]

Parameters:

clsName -

Returns:

Throws:

java.lang.IllegalArgumentException - if class not found.

getAllSuperclasses

public static java.util.List<java.lang.Class<?>> getAllSuperclasses(java.lang.Class<?> cls)

Copied from Apache Commons Lang under Apache License v2.

Gets a List of super classes for the given class, excluding Object.class.

Parameters:

cls - the class to look up.

Returns:

the List of super classes in order going up from this one.

getAllInterfaces

public static java.util.Set<java.lang.Class<?>> getAllInterfaces(java.lang.Class<?> cls)

Copied from Apache Commons Lang under Apache License v2.

Gets a List of all interfaces implemented by the given class and its super classes.

The order is determined by looking through each interface in turn as declared in the source file and following its hierarchy up. Then each superclass is considered in the same way. Later duplicates are ignored, so the order is maintained.

Parameters:

cls - the class to look up.

Returns:

the List of interfaces in order

getAllSuperTypes

public static java.util.Set<java.lang.Class<?>> getAllSuperTypes(java.lang.Class<?> cls)

Returns all the interfaces and super classes the specified class implements or extends, excluding Object.class.

Parameters:

cls -

Returns:

getParameterizedTypeNameByMethod

public static java.lang.String getParameterizedTypeNameByMethod(java.lang.reflect.Method method)

getTypeArgumentsByMethod

public static java.lang.Class<?>[] getTypeArgumentsByMethod(java.lang.reflect.Method method)

getPackage

public static java.lang.Package getPackage(java.lang.Class<?> cls)

Parameters:

cls -

Returns:

null if it's primitive type or no package defined for the class.

getPackageName

public static java.lang.String getPackageName(java.lang.Class<?> cls)

Parameters:

cls -

Returns:

null if it's primitive type or no package defined for the class.

getClassesByPackage

public static java.util.List<java.lang.Class<?>> getClassesByPackage(java.lang.String pkgName,
                                                                     boolean isRecursive,
                                                                     boolean skipClassLoaddingException)

getClassesByPackage

public static <E extends java.lang.Exception> java.util.List<java.lang.Class<?>> getClassesByPackage(java.lang.String pkgName,
                                                                                                     boolean isRecursive,
                                                                                                     boolean skipClassLoaddingException,
                                                                                                     Try.Predicate<? super java.lang.Class<?>,E> predicate)
                                                                                              throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

getClassName

public static java.lang.String getClassName(java.lang.Class<?> cls)

getSimpleClassName

public static java.lang.String getSimpleClassName(java.lang.Class<?> cls)

getCanonicalClassName

public static java.lang.String getCanonicalClassName(java.lang.Class<?> cls)

getEnclosingClass

public static java.lang.Class<?> getEnclosingClass(java.lang.Class<?> cls)

getDeclaredConstructor

@SafeVarargs
public static <T> java.lang.reflect.Constructor<T> getDeclaredConstructor(java.lang.Class<T> cls,
                                                                                        java.lang.Class<?>... parameterTypes)

Returns the constructor declared in the specified cls with the specified parameterTypes.

Parameters:

cls -

parameterTypes -

Returns:

null if no constructor is found

getDeclaredMethod

@SafeVarargs
public static java.lang.reflect.Method getDeclaredMethod(java.lang.Class<?> cls,
                                                                       java.lang.String methodName,
                                                                       java.lang.Class<?>... parameterTypes)

Returns the method declared in the specified cls with the specified methodName and parameterTypes.

Parameters:

cls -

methodName -

parameterTypes -

Returns:

null if no method is found

invokeConstructor

@SafeVarargs
public static <T> T invokeConstructor(java.lang.reflect.Constructor<T> constructor,
                                                    java.lang.Object... args)

invokeMethod

@SafeVarargs
public static <T> T invokeMethod(java.lang.reflect.Method method,
                                               java.lang.Object... args)

invokeMethod

@SafeVarargs
public static <T> T invokeMethod(java.lang.Object instance,
                                               java.lang.reflect.Method method,
                                               java.lang.Object... args)

getPropNameList

public static java.util.List<java.lang.String> getPropNameList(java.lang.Class<?> cls)

Returns an immutable entity property name List by the specified class.

Parameters:

cls -

Returns:

getPropNameListExclusively

public static java.util.List<java.lang.String> getPropNameListExclusively(java.lang.Class<?> cls,
                                                                          java.util.Set<java.lang.String> propNameToExcluded)

Parameters:

cls -

propNameToExcluded -

Returns:

getPropNameListExclusively

public static java.util.List<java.lang.String> getPropNameListExclusively(java.lang.Class<?> cls,
                                                                          java.util.Collection<java.lang.String> propNameToExcluded)

getPropGetMethodList

public static java.util.Map<java.lang.String,java.lang.reflect.Method> getPropGetMethodList(java.lang.Class<?> cls)

Call registerXMLBindingClassForPropGetSetMethod first to retrieve the property getter/setter method for the class/bean generated/wrote by JAXB specificatio

Parameters:

cls -

Returns:

getPropSetMethodList

public static java.util.Map<java.lang.String,java.lang.reflect.Method> getPropSetMethodList(java.lang.Class<?> cls)

getPropGetMethod

public static java.lang.reflect.Method getPropGetMethod(java.lang.Class<?> cls,
                                                        java.lang.String propName)

Returns the property get method declared in the specified cls with the specified property name propName. null is returned if no method is found. Call registerXMLBindingClassForPropGetSetMethod first to retrieve the property getter/setter method for the class/bean generated/wrote by JAXB specificatio

Parameters:

cls -

propName -

Returns:

getPropSetMethod

public static java.lang.reflect.Method getPropSetMethod(java.lang.Class<?> cls,
                                                        java.lang.String propName)

Returns the property set method declared in the specified cls with the specified property name propName. null is returned if no method is found.

Parameters:

cls -

propName -

Returns:

getPropField

public static java.lang.reflect.Field getPropField(java.lang.Class<?> cls,
                                                   java.lang.String propName)

getPropValue

public static <T> T getPropValue(java.lang.Object entity,
                                 java.lang.reflect.Method propGetMethod)

Return the specified propValue got by the specified method propSetMethod in the specified entity.

Parameters:

entity - MapEntity is not supported

propGetMethod -

Returns:

setPropValue

public static void setPropValue(java.lang.Object entity,
                                java.lang.reflect.Method propSetMethod,
                                java.lang.Object propValue)

Set the specified propValue to entity by the specified method propSetMethod. This method will try to convert propValue to appropriate type and set again if fails to set in the first time. The final value which is set to the property will be returned if property is set successfully finally. it could be the input propValue or converted property value, otherwise, exception will be threw if the property value is set unsuccessfully.

Parameters:

entity - MapEntity is not supported

propSetMethod -

propValue -

setPropValueByGet

public static void setPropValueByGet(java.lang.Object entity,
                                     java.lang.reflect.Method propGetMethod,
                                     java.lang.Object propValue)

getPropValue

public static <T> T getPropValue(java.lang.Object entity,
                                 java.lang.String propName)

Refer to getPropValue(Method, Object)

Parameters:

entity -

propName - is case insensitive

Returns:

getPropValue(Object, Method)

getPropValue

public static <T> T getPropValue(java.lang.Object entity,
                                 java.lang.String propName,
                                 boolean ignoreUnknownProperty)

Parameters:

entity -

propName -

ignoreUnknownProperty -

Returns:

the property value or null if the property doesn't belong to specified entity.

Throws:

java.lang.IllegalArgumentException - if the specified property can't be gotten and ignoreUnknownProperty is false.

setPropValue

public static void setPropValue(java.lang.Object entity,
                                java.lang.String propName,
                                java.lang.Object propValue)

Refer to setPropValue(Method, Object, Object).

Parameters:

entity -

propName - is case insensitive

propValue -

setPropValue

public static boolean setPropValue(java.lang.Object entity,
                                   java.lang.String propName,
                                   java.lang.Object propValue,
                                   boolean ignoreUnknownProperty)

Parameters:

entity -

propName -

propValue -

ignoreUnknownProperty -

Returns:

true if the property value has been set.

Throws:

java.lang.IllegalArgumentException - if the specified property can't be set and ignoreUnknownProperty is false.

getPropNameByMethod

public static java.lang.String getPropNameByMethod(java.lang.reflect.Method getSetMethod)

formalizePropName

public static java.lang.String formalizePropName(java.lang.String propName)

It's designed for field/method/class/column/table names. and source and target Strings will be cached.

Parameters:

propName -

Returns:

toLowerCaseWithUnderscore

public static java.lang.String toLowerCaseWithUnderscore(java.lang.String str)

It's designed for field/method/class/column/table names. and source and target Strings will be cached.

Parameters:

str -

Returns:

toLowerCaseKeyWithUnderscore

public static void toLowerCaseKeyWithUnderscore(java.util.Map<java.lang.String,java.lang.Object> props)

toUpperCaseWithUnderscore

public static java.lang.String toUpperCaseWithUnderscore(java.lang.String str)

It's designed for field/method/class/column/table names. and source and target Strings will be cached.

Parameters:

str -

Returns:

toUpperCaseKeyWithUnderscore

public static void toUpperCaseKeyWithUnderscore(java.util.Map<java.lang.String,java.lang.Object> props)