de.alpharogroup.lang

Class ClassExtensions

java.lang.Object

de.alpharogroup.lang.ClassExtensions

public final class ClassExtensions
extends Object

The class ClassExtensions provides extension methods for the class Class.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CGLIB_TAG The Constant CGLIB_TAG contains the tag of a cglib class name.

Constructor Summary

Constructors

Constructor and Description
ClassExtensions()

Method Summary

Modifier and Type	Method and Description
static Class<?>	forName(@NonNull String className) Look up the class in the "current" ClassLoader.
static Class<?>	getBaseClass(Class<?> childClass) Gets the parent base class from the given child class.
static String	getCallingMethodName(@NonNull StackTraceElement[] elements) Gets the calling method name.
static Class<?>	getCglibProxy(@NonNull Class<?> clazz) Gets the real class if the given class is decorated with cglib proxy classes.
static <T> Class<T>	getClass(T object) Gets the Class of the given object.
static ClassLoader	getClassLoader() Gets the current class loader.
static ClassLoader	getClassLoader(Object obj) Gets the ClassLoader from the given object.
static String	getClassname(@NonNull Class<?> clazz) Gets the classname from the given class.
static String	getClassnameWithSuffix(@NonNull Class<?> clazz) Gets the classname and concats the suffix ".class" from the class.
static String	getClassnameWithSuffix(@NonNull Object obj) Gets the classname and concats the suffix ".class" from the object.
static ClassType	getClassType(@NonNull Class<?> clazz) Gets the ClassType from the given class.
static String	getCurrentMethodName(@NonNull StackTraceElement[] elements) Gets the current method name.
static List<File>	getDirectoriesFromResources(@NonNull String path, boolean isPackage) Gets the directories from the given path.
static String	getJarPath(@NonNull Class<?> clazz) If the given class is in a JAR file than the jar path as String will be returned.
static Class<?>[]	getJdkProxyInterfaces(@NonNull Class<?> clazz) Gets the jdk proxy interfaces.
static String	getManifestUrl(@NonNull Class<?> clazz) If the given class is in a JAR, WAR or EAR file than the manifest url as String is returned.
static String	getName(@NonNull Class<?> clazz) Returns the name of the given class or null if the given class is null.
static String	getName(Class<?> clazz, boolean simple) Returns the name of the given class or null if the given class is null.
static String	getPath(@NonNull Class<?> clazz) Gets the path from the given class.
static String	getPathFromObject(Object obj) Finds the absolute path from the object.
static URL	getResource(@NonNull Class<?> clazz) Gives the url from the path back.
static URL	getResource(@NonNull Class<?> clazz, @NonNull String path) Gives the url from the path back.
static URL	getResource(@NonNull String name) Gives the URL from the resource.
static <T> URL	getResource(@NonNull String name, T obj) Gives the URL from the resource.
static File	getResourceAsFile(@NonNull String name) Gives the resource as a file Object.
static File	getResourceAsFile(@NonNull String name, @NonNull Object obj) Gives the resource as a file Object.
static InputStream	getResourceAsStream(@NonNull Class<?> clazz, @NonNull String uri) This method call the getResourceAsStream from the ClassLoader.
static InputStream	getResourceAsStream(@NonNull String name) Gives the Inputstream from the resource.
static InputStream	getResourceAsStream(@NonNull String name, @NonNull Object obj) Gives the Inputstream from the resource.
static List<URL>	getResources(@NonNull String path) Gets a list with urls from the given path for all resources.
static String	getSimpleName(@NonNull Class<?> clazz) Returns the simple name of the given class or null if the given class is null.
static Class<?>	getUnwrappedProxy(Class<?> clazz) Gets the unwrapped proxy class.
static URL	getURL(@NonNull Class<?> clazz) Returns the URL from the given class.
static <T> boolean	isCglib(Class<T> clazz) Checks if the given Class is cglib proxy class.
static boolean	isCollection(@NonNull Class<?> clazz) Checks if the given class is assignable from Collection.
static boolean	isDerivate(ClassLoader source, ClassLoader compare) Compares the two given ClassLoader objects and returns true if compare is a derivate of source.
static <T> boolean	isJdkProxy(Class<T> clazz) Checks if the given Class is a JDK proxy class.
static boolean	isMap(@NonNull Class<?> clazz) Checks if the given class is assignable from Map.
static <T> boolean	isProxy(Class<T> clazz) Checks if the given Class is a proxy class.
static Class<?>[]	unwrapProxy(Class<?> clazz) Unwrap the given Class if it is wrapped from cglib or jdk proxies.

Methods inherited from class java.lang.Object

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

Field Detail

CGLIB_TAG

protected static final String CGLIB_TAG

The Constant CGLIB_TAG contains the tag of a cglib class name.

See Also:

Constant Field Values

Constructor Detail

ClassExtensions

public ClassExtensions()

Method Detail

forName

public static Class<?> forName(@NonNull
                               @NonNull String className)
                        throws ClassNotFoundException

Look up the class in the "current" ClassLoader.

Parameters:

className - The class name to load

Returns:

the class

Throws:

ClassNotFoundException - is thrown if the Class was not found or could not be located.

getBaseClass

public static Class<?> getBaseClass(Class<?> childClass)

Gets the parent base class from the given child class.

Parameters:

childClass - the child class

Returns:

the parent base class from the given child class.

getCallingMethodName

public static String getCallingMethodName(@NonNull
                                          @NonNull StackTraceElement[] elements)

Gets the calling method name.

Parameters:

elements - the elements

Returns:

the calling method name

getCglibProxy

public static Class<?> getCglibProxy(@NonNull
                                     @NonNull Class<?> clazz)

Gets the real class if the given class is decorated with cglib proxy classes.

Parameters:

clazz - the class

Returns:

the real class if the given class is decorated with cglib proxy classes and if not the given class will be returned.

getClass

public static <T> Class<T> getClass(T object)

Gets the Class of the given object.

Type Parameters:

T - the generic type

Parameters:

object - the object to resolve the class

Returns:

the Class of the given object or null if the object is null.

getClassLoader

public static ClassLoader getClassLoader()

Gets the current class loader.

Returns:

's the current class loader

getClassLoader

public static ClassLoader getClassLoader(Object obj)

Gets the ClassLoader from the given object.

Parameters:

obj - The object.

Returns:

the ClassLoader from the given object.

getClassname

public static String getClassname(@NonNull
                                  @NonNull Class<?> clazz)

Gets the classname from the given class.

Parameters:

clazz - The class.

Returns:

The classname.

getClassnameWithSuffix

public static String getClassnameWithSuffix(@NonNull
                                            @NonNull Class<?> clazz)

Gets the classname and concats the suffix ".class" from the class.

Parameters:

clazz - The class.

Returns:

The classname and concats the suffix ".class".

getClassnameWithSuffix

public static String getClassnameWithSuffix(@NonNull
                                            @NonNull Object obj)

Gets the classname and concats the suffix ".class" from the object.

Parameters:

obj - The object.

Returns:

The classname and concats the suffix ".class".

getClassType

public static ClassType getClassType(@NonNull
                                     @NonNull Class<?> clazz)

Gets the ClassType from the given class.

Parameters:

clazz - The class.

Returns:

the ClassType from the given class.

getCurrentMethodName

public static String getCurrentMethodName(@NonNull
                                          @NonNull StackTraceElement[] elements)

Gets the current method name.

Parameters:

elements - the elements

Returns:

the current method name

getDirectoriesFromResources

public static List<File> getDirectoriesFromResources(@NonNull
                                                     @NonNull String path,
                                                     boolean isPackage)
                                              throws IOException,
                                                     URISyntaxException

Gets the directories from the given path.

Parameters:

path - the path

isPackage - If the Flag is true than the given path is a package.

Returns:

the directories from resources

Throws:

IOException - Signals that an I/O exception has occurred.

URISyntaxException - is thrown if a string could not be parsed as a URI reference.

getJarPath

public static String getJarPath(@NonNull
                                @NonNull Class<?> clazz)

If the given class is in a JAR file than the jar path as String will be returned.

Parameters:

clazz - The class.

Returns:

the jar path as String if the given class is in a JAR file.

getJdkProxyInterfaces

public static Class<?>[] getJdkProxyInterfaces(@NonNull
                                               @NonNull Class<?> clazz)

Gets the jdk proxy interfaces.

Parameters:

clazz - the class

Returns:

the jdk proxy interfaces

getManifestUrl

public static String getManifestUrl(@NonNull
                                    @NonNull Class<?> clazz)

If the given class is in a JAR, WAR or EAR file than the manifest url as String is returned.

Parameters:

clazz - The class.

Returns:

the manifest url as String if the given class is in a JAR, WAR or EAR file.

getName

public static String getName(@NonNull
                             @NonNull Class<?> clazz)

Returns the name of the given class or null if the given class is null.

Parameters:

clazz - The class.

Returns:

The name of the given class.

getName

public static String getName(Class<?> clazz,
                             boolean simple)

Returns the name of the given class or null if the given class is null. If the given flag 'simple' is true the simple name (without the package) will be returned.

Parameters:

clazz - The class

simple - The flag if the simple name should be returned.

Returns:

The name of the given class or if the given flag 'simple' is true the simple name (without the package) will be returned.

getPath

public static String getPath(@NonNull
                             @NonNull Class<?> clazz)

Gets the path from the given class. For instance /java/lang/Object.class if the given class is from Object

Parameters:

clazz - The class.

Returns:

the path from the given class.

getPathFromObject

public static String getPathFromObject(Object obj)

Finds the absolute path from the object.

Parameters:

obj - The object.

Returns:

The absolute path from the object.

getResource

public static URL getResource(@NonNull
                              @NonNull Class<?> clazz)

Gives the url from the path back.

Parameters:

clazz - The class-object.

Returns:

's the url from the path.

getResource

public static URL getResource(@NonNull
                              @NonNull Class<?> clazz,
                              @NonNull
                              @NonNull String path)

Gives the url from the path back.

Parameters:

clazz - The class-object.

path - The path.

Returns:

's the url from the path.

getResource

public static URL getResource(@NonNull
                              @NonNull String name)

Gives the URL from the resource. Wrapes the Class.getResource(String)-method.

Parameters:

name - The name from the resource.

Returns:

The resource or null if the resource does not exists.

getResource

public static <T> URL getResource(@NonNull
                                  @NonNull String name,
                                  @NonNull
                                  T obj)

Gives the URL from the resource. Wrapes the Class.getResource(String)-method.

Type Parameters:

T - the generic type

Parameters:

name - The name from the resource.

obj - The Object.

Returns:

The resource or null if the resource does not exists.

getResourceAsFile

public static File getResourceAsFile(@NonNull
                                     @NonNull String name)
                              throws URISyntaxException

Gives the resource as a file Object.

Parameters:

name - The name from the file.

Returns:

The file or null if the file does not exists.

Throws:

URISyntaxException - occurs by creation of the file with an uri.

getResourceAsFile

public static File getResourceAsFile(@NonNull
                                     @NonNull String name,
                                     @NonNull
                                     @NonNull Object obj)
                              throws URISyntaxException,
                                     IOException

Gives the resource as a file Object.

Parameters:

name - The name from the file.

obj - The Object.

Returns:

The file or null if the file does not exists.

Throws:

URISyntaxException - occurs by creation of the file with an uri.

IOException - Signals that an I/O exception has occurred.

getResourceAsStream

public static InputStream getResourceAsStream(@NonNull
                                              @NonNull Class<?> clazz,
                                              @NonNull
                                              @NonNull String uri)

This method call the getResourceAsStream from the ClassLoader. You can use this method to read files from jar-files.

Parameters:

clazz - the clazz

uri - The uri as String.

Returns:

The InputStream from the uri.

getResourceAsStream

public static InputStream getResourceAsStream(@NonNull
                                              @NonNull String name)

Gives the Inputstream from the resource. Wrapes the Class.getResourceAsStream(String)-method.

Parameters:

name - The name from the resource.

Returns:

The resource or null if the resource does not exists.

getResourceAsStream

public static InputStream getResourceAsStream(@NonNull
                                              @NonNull String name,
                                              @NonNull
                                              @NonNull Object obj)

Gives the Inputstream from the resource. Wrapes the Class.getResourceAsStream(String)-method.

Parameters:

name - The name from the resource.

obj - The Object.

Returns:

The resource or null if the resource does not exists.

getResources

public static List<URL> getResources(@NonNull
                                     @NonNull String path)
                              throws IOException

Gets a list with urls from the given path for all resources.

Parameters:

path - The base path.

Returns:

The resources.

Throws:

IOException - Signals that an I/O exception has occurred.

getSimpleName

public static String getSimpleName(@NonNull
                                   @NonNull Class<?> clazz)

Returns the simple name of the given class or null if the given class is null.

Parameters:

clazz - The class.

Returns:

The simple name of the given class.

getUnwrappedProxy

public static Class<?> getUnwrappedProxy(Class<?> clazz)

Gets the unwrapped proxy class.

Parameters:

clazz - the class

Returns:

the unwrapped proxy class or null if the given Class is null.

getURL

public static URL getURL(@NonNull
                         @NonNull Class<?> clazz)

Returns the URL from the given class.

Parameters:

clazz - The class.

Returns:

the URL from the given class.

isCglib

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

Checks if the given Class is cglib proxy class.

Type Parameters:

T - the generic type

Parameters:

clazz - the class to check

Returns:

true, if the given Class is cglib proxy class otherwise false.

isCollection

public static boolean isCollection(@NonNull
                                   @NonNull Class<?> clazz)

Checks if the given class is assignable from Collection.

Parameters:

clazz - The class.

Returns:

true, if the given class is assignable from Collection otherwise false.

isDerivate

public static boolean isDerivate(ClassLoader source,
                                 ClassLoader compare)

Compares the two given ClassLoader objects and returns true if compare is a derivate of source.

Parameters:

source - the source

compare - the compare

Returns:

true, if compare is a derivate of source.

isJdkProxy

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

Checks if the given Class is a JDK proxy class.

Type Parameters:

T - the generic type

Parameters:

clazz - the class to check

Returns:

true, if the given Class is a JDK proxy class otherwise false.

isMap

public static boolean isMap(@NonNull
                            @NonNull Class<?> clazz)

Checks if the given class is assignable from Map.

Parameters:

clazz - The class.

Returns:

true, if the given class is assignable from Map otherwise false.

isProxy

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

Checks if the given Class is a proxy class.

Type Parameters:

T - the generic type

Parameters:

clazz - the class to check

Returns:

true, if the given Class is a proxy class otherwise false.

unwrapProxy

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

Unwrap the given Class if it is wrapped from cglib or jdk proxies.

Parameters:

clazz - the class

Returns:

the unwrapped classes as an array