icy.util

Class ClassUtil

java.lang.Object

icy.util.ClassUtil

public class ClassUtil
extends java.lang.Object

Author:

stephane

Constructor Summary

Constructors

Constructor and Description
ClassUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	filenameToClassname(java.lang.String fileName) This method checks and transforms the filename of a potential Class given by fileName.
static java.lang.Class<?>	findClass(java.lang.String className) Get Class object of specified class name.
static void	findClassNameInFile(java.io.File file, boolean includeJar, java.util.Set<java.lang.String> classSet, java.lang.String qualifiedNamePrefix) Search for all classes in specified file
static void	findClassNameInFile(java.io.File file, java.util.Set<java.lang.String> classSet, java.lang.String qualifiedNamePrefix) Search for all classes in specified file
static java.util.Set<java.lang.String>	findClassNamesInJAR(java.lang.String fileName) Search for all classes in JAR file
static void	findClassNamesInJAR(java.lang.String fileName, java.util.Set<java.lang.String> classSet) Search for all classes in JAR file
static java.util.Set<java.lang.String>	findClassNamesInPackage(java.lang.String packageName, boolean includeSubPackages) This method finds all classes that are located in the package identified by the given packageName.
static void	findClassNamesInPackage(java.lang.String packageName, boolean includeSubPackages, java.util.Set<java.lang.String> classes) This method finds all classes that are located in the package identified by the given packageName.
static java.util.HashSet<java.lang.String>	findClassNamesInPath(java.lang.String path, boolean includeSubDir) This method finds all classes that are located in the specified directory.
static java.util.HashSet<java.lang.String>	findClassNamesInPath(java.lang.String path, boolean includeSubDir, boolean includeJar) This method finds all classes that are located in the specified directory.
static java.util.HashSet<java.lang.String>	findClassNamesInPath(java.lang.String path, java.lang.String packageName, boolean includeSubDir) This method finds all classes that are located in the specified directory.
static java.util.HashSet<java.lang.String>	findClassNamesInPath(java.lang.String path, java.lang.String packageName, boolean includeSubDir, boolean includeJar) This method finds all classes that are located in the specified directory.
static void	findClassNamesInPath(java.lang.String path, java.lang.String packageName, boolean includeSubDir, boolean includeJar, java.util.Set<java.lang.String> classes) This method finds all classes that are located in the specified directory.
static void	findClassNamesInPath(java.lang.String path, java.lang.String packageName, boolean includeSubDir, java.util.Set<java.lang.String> classes) This method finds all classes that are located in the specified directory.
static void	findResourceInFile(java.io.File file, boolean includeJar, boolean includeHidden, java.util.List<java.lang.String> result, java.lang.String basePath) Search for all classes in specified file
static java.lang.String	fixClassName(java.lang.String fileName) This method checks and transforms the filename of a potential Class given by fileName.
static java.lang.String	getBaseClassName(java.lang.String className) Get the base class name ex : "plugin.myClass$InternClass$1" --> "plugin.myClass"
static java.lang.ClassLoader	getContextClassLoader() Return the current thread context class loader
static java.lang.reflect.Field	getField(java.lang.Object object, java.lang.String fieldName, boolean forceAccess) Deprecated. Use ReflectionUtil.getField(Object, String, boolean) instead
static java.lang.Object	getFieldObject(java.lang.Object object, java.lang.String fieldName, boolean forceAccess) Deprecated. Use ReflectionUtil.getFieldObject(Object, String, boolean) instead
static java.io.File	getFile(java.lang.String fullClassName) Find the file (.jar or .class usually) that host this class.
static java.lang.String	getFirstPackageName(java.lang.String className) Get first package name ex : "plugin.test.myClass" --> "plugin"
static java.lang.Class<?>[]	getInterfaces(java.lang.Class<?> c) Return true if clazz implements the specified interface
static java.lang.String	getJarPath(java.lang.Class<?> c) Returns the source JAR file (if any) from where the specified class has been loaded from
static java.util.List<java.lang.Class<?>>	getLoadedClasses(java.lang.ClassLoader cl) Return the list of all loaded classes by the specified ClassLoader.
static java.lang.reflect.Method	getMethod(java.lang.Object object, java.lang.String methodName, boolean forceAccess, java.lang.Class<?>... parameterTypes) Deprecated. Use ReflectionUtil.getMethod(Object, String, boolean, Class...) instead
static java.lang.String	getPackageName(java.lang.String className) Get package name ex : "plugin.test.myClass" --> "plugin.test"
static java.lang.String	getPathFromQualifiedName(java.lang.String qualifiedName) Transform the specified qualified name in path.
static java.lang.Class<?>	getPrimitiveType(java.lang.String primitiveName)
static java.lang.String	getQualifiedNameFromPath(java.lang.String path) Transform the specified path in qualified name.
static java.util.List<java.lang.String>	getResourcesInPackage(java.lang.String packageName, java.lang.String extension, boolean recursive, boolean includeFolder, boolean includeJar, boolean includeHidden) This method returns all resources that are located in the package identified by the given packageName.
static java.util.List<java.lang.String>	getResourcesInPath(java.lang.String path, boolean recursive, boolean includeFolder, boolean includeJar, boolean includeHidden) This method returns all resources that are located in the specified path.
static java.util.List<java.lang.String>	getResourcesInPath(java.lang.String path, java.lang.String basePath, boolean recursive, boolean includeFolder, boolean includeJar, boolean includeHidden) This method returns all resources that are located in the specified path.
static void	getResourcesInPath(java.lang.String path, java.lang.String basePath, boolean recursive, boolean includeFolder, boolean includeJar, boolean includeHidden, java.util.List<java.lang.String> result) This method returns all resources that are located in the specified path.
static java.lang.String	getSimpleClassName(java.lang.String className) Get simple class name ex : "plugin.test.myClass$InternClass$1" --> "myClass$InternClass$1"
static java.lang.ClassLoader	getSystemClassLoader() Return the system class loader
static java.lang.Object	invokeMethod(java.lang.Object object, java.lang.String methodName, boolean forceAccess, java.lang.Object... args) Deprecated. Use ReflectionUtil.invokeMethod(Object, String, boolean, Object...) instead
static boolean	isAbstract(java.lang.Class<?> c) Return true if class is abstract
static boolean	isPrivate(java.lang.Class<?> c) Return true if class is private
static boolean	isPublic(java.lang.Class<?> c) Return true if class is public
static boolean	isSubClass(java.lang.Class<?> clazz, java.lang.Class<?> baseClass) Return true if clazz is the same class or extends baseClass

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassUtil

public ClassUtil()

Method Detail

getContextClassLoader

public static java.lang.ClassLoader getContextClassLoader()

Return the current thread context class loader

getSystemClassLoader

public static java.lang.ClassLoader getSystemClassLoader()

Return the system class loader

getLoadedClasses

public static java.util.List<java.lang.Class<?>> getLoadedClasses(java.lang.ClassLoader cl)

Return the list of all loaded classes by the specified ClassLoader.
Warning: this function is not safe and would not always work as expected.
It can return null if an error occurred.

getPrimitiveType

public static java.lang.Class<?> getPrimitiveType(java.lang.String primitiveName)

Parameters:

primitiveName -

Returns:

The Java primitive type represented by the given name, or null if the given name does not represent a primitive type

findClass

public static java.lang.Class<?> findClass(java.lang.String className)
                                    throws java.lang.ClassNotFoundException

Get Class object of specified class name.
First search in Plugin Class loader then from the system class loader.
Primitive type are accepted.

Throws:

java.lang.ClassNotFoundException

getQualifiedNameFromPath

public static java.lang.String getQualifiedNameFromPath(java.lang.String path)

Transform the specified path in qualified name.

ex : "document/class/loader.class" --> "document.class.loader.class" (unix) "document\class\loader.class" --> "document.class.loader.class" (win)

Parameters:

path -

getPathFromQualifiedName

public static java.lang.String getPathFromQualifiedName(java.lang.String qualifiedName)

Transform the specified qualified name in path.
Be careful, this function do not handle the file extension.

ex : "plugins.user.loader.test" --> "plugins/user/loader/test"

getPackageName

public static java.lang.String getPackageName(java.lang.String className)

Get package name
ex : "plugin.test.myClass" --> "plugin.test"

getFirstPackageName

public static java.lang.String getFirstPackageName(java.lang.String className)

Get first package name
ex : "plugin.test.myClass" --> "plugin"

getBaseClassName

public static java.lang.String getBaseClassName(java.lang.String className)

Get the base class name
ex : "plugin.myClass$InternClass$1" --> "plugin.myClass"

getSimpleClassName

public static java.lang.String getSimpleClassName(java.lang.String className)

Get simple class name
ex : "plugin.test.myClass$InternClass$1" --> "myClass$InternClass$1"

getJarPath

public static java.lang.String getJarPath(java.lang.Class<?> c)

Returns the source JAR file (if any) from where the specified class has been loaded from

getInterfaces

public static java.lang.Class<?>[] getInterfaces(java.lang.Class<?> c)

Return true if clazz implements the specified interface

isAbstract

public static boolean isAbstract(java.lang.Class<?> c)

Return true if class is abstract

isPublic

public static boolean isPublic(java.lang.Class<?> c)

Return true if class is public

isPrivate

public static boolean isPrivate(java.lang.Class<?> c)

Return true if class is private

isSubClass

public static boolean isSubClass(java.lang.Class<?> clazz,
                 java.lang.Class<?> baseClass)

Return true if clazz is the same class or extends baseClass

getResourcesInPackage

public static java.util.List<java.lang.String> getResourcesInPackage(java.lang.String packageName,
                                                     java.lang.String extension,
                                                     boolean recursive,
                                                     boolean includeFolder,
                                                     boolean includeJar,
                                                     boolean includeHidden)
                                                              throws java.io.IOException

This method returns all resources that are located in the package identified by the given packageName.
WARNING:
This is a relative expensive operation. Depending on your classpath multiple directories, JAR and WAR files may need to be scanned.
Original code written by Jorg Hohwiller for the m-m-m project (http://m-m-m.sf.net)

Parameters:

packageName - is the name of the Package to scan (ex: "java.awt.metrics")

extension - resource extension if we want to retrieve only a specific type of resource (ex: ".class")
Note that extension filtering is not case sensitive.

recursive - if set to true files from sub packages/folder are also returned.

includeFolder - if true folder entry are also returned

includeJar - if true all sub JAR files are also scanned

includeHidden - if true all hidden files (starting by '.' character) are also scanned

Returns:

all files contained in this package represented in path format (ex: "java/awt/geom/Rectangle2D.class")

Throws:

java.io.IOException

getResourcesInPath

public static java.util.List<java.lang.String> getResourcesInPath(java.lang.String path,
                                                  boolean recursive,
                                                  boolean includeFolder,
                                                  boolean includeJar,
                                                  boolean includeHidden)

This method returns all resources that are located in the specified path.

Parameters:

path - path to scan.

recursive - if true all sub folder are also scanned.

includeJar - if true all JAR files are also scanned

includeHidden - if true all hidden files (starting by '.' character) are also scanned

Returns:

list of found resources.

getResourcesInPath

public static java.util.List<java.lang.String> getResourcesInPath(java.lang.String path,
                                                  java.lang.String basePath,
                                                  boolean recursive,
                                                  boolean includeFolder,
                                                  boolean includeJar,
                                                  boolean includeHidden)

This method returns all resources that are located in the specified path.

Parameters:

path - path to scan.

basePath - path prefix

recursive - if true all sub folder are also scanned.

includeJar - if true all JAR files are also scanned

includeHidden - if true all hidden files (starting by '.' character) are also scanned

Returns:

set of found class.

getResourcesInPath

public static void getResourcesInPath(java.lang.String path,
                      java.lang.String basePath,
                      boolean recursive,
                      boolean includeFolder,
                      boolean includeJar,
                      boolean includeHidden,
                      java.util.List<java.lang.String> result)

This method returns all resources that are located in the specified path.

Parameters:

path - path to scan.

basePath - path prefix

recursive - if true all sub folder are also scanned.

includeJar - if true all JAR files are also scanned

includeHidden - if true all hidden files (starting by '.' character) are also scanned

result - result list

findResourceInFile

public static void findResourceInFile(java.io.File file,
                      boolean includeJar,
                      boolean includeHidden,
                      java.util.List<java.lang.String> result,
                      java.lang.String basePath)

Search for all classes in specified file

findClassNamesInPackage

public static java.util.Set<java.lang.String> findClassNamesInPackage(java.lang.String packageName,
                                                      boolean includeSubPackages)
                                                               throws java.io.IOException

This method finds all classes that are located in the package identified by the given packageName.
ATTENTION:
This is a relative expensive operation. Depending on your classpath multiple directories,JAR-, and WAR-files may need to be scanned.

Parameters:

packageName - is the name of the Package to scan.

includeSubPackages - - if true all sub-packages of the specified Package will be included in the search.

Returns:

found classes set

Throws:

java.io.IOException - if the operation failed with an I/O error.

findClassNamesInPackage

public static void findClassNamesInPackage(java.lang.String packageName,
                           boolean includeSubPackages,
                           java.util.Set<java.lang.String> classes)
                                    throws java.io.IOException

This method finds all classes that are located in the package identified by the given packageName.
ATTENTION:
This is a relative expensive operation. Depending on your classpath multiple directories,JAR-, and WAR-files may need to be scanned.
Original code written by Jorg Hohwiller for the m-m-m project (http://m-m-m.sf.net)

Parameters:

packageName - is the name of the Package to scan.

includeSubPackages - - if true all sub-packages of the specified Package will be included in the search.

classes - save found classes here

Throws:

java.io.IOException

findClassNamesInPath

public static java.util.HashSet<java.lang.String> findClassNamesInPath(java.lang.String path,
                                                       boolean includeSubDir)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

includeSubDir - if true all sub-directory are also scanned.

Returns:

set of found class.

findClassNamesInPath

public static java.util.HashSet<java.lang.String> findClassNamesInPath(java.lang.String path,
                                                       boolean includeSubDir,
                                                       boolean includeJar)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

includeSubDir - if true all sub-directory are also scanned.

includeJar - if true all JAR files are also scanned

Returns:

set of found class.

findClassNamesInPath

public static java.util.HashSet<java.lang.String> findClassNamesInPath(java.lang.String path,
                                                       java.lang.String packageName,
                                                       boolean includeSubDir)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

packageName - package name prefix

includeSubDir - if true all sub-directory are also scanned.

Returns:

set of found class.

findClassNamesInPath

public static java.util.HashSet<java.lang.String> findClassNamesInPath(java.lang.String path,
                                                       java.lang.String packageName,
                                                       boolean includeSubDir,
                                                       boolean includeJar)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

packageName - package name prefix

includeSubDir - if true all sub-directory are also scanned.

includeJar - if true all JAR files are also scanned

Returns:

set of found class.

findClassNamesInPath

public static void findClassNamesInPath(java.lang.String path,
                        java.lang.String packageName,
                        boolean includeSubDir,
                        java.util.Set<java.lang.String> classes)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

packageName - package name prefix

includeSubDir - if true all sub-directory are also scanned.

classes - save found classes here

findClassNamesInPath

public static void findClassNamesInPath(java.lang.String path,
                        java.lang.String packageName,
                        boolean includeSubDir,
                        boolean includeJar,
                        java.util.Set<java.lang.String> classes)

This method finds all classes that are located in the specified directory.

Parameters:

path - path to scan.

packageName - package name prefix

includeSubDir - if true all sub-directory are also scanned.

includeJar - if true all JAR files are also scanned

classes - save found classes here

findClassNameInFile

public static void findClassNameInFile(java.io.File file,
                       boolean includeJar,
                       java.util.Set<java.lang.String> classSet,
                       java.lang.String qualifiedNamePrefix)

Search for all classes in specified file

findClassNameInFile

public static void findClassNameInFile(java.io.File file,
                       java.util.Set<java.lang.String> classSet,
                       java.lang.String qualifiedNamePrefix)

Search for all classes in specified file

findClassNamesInJAR

public static void findClassNamesInJAR(java.lang.String fileName,
                       java.util.Set<java.lang.String> classSet)

Search for all classes in JAR file

findClassNamesInJAR

public static java.util.Set<java.lang.String> findClassNamesInJAR(java.lang.String fileName)

Search for all classes in JAR file

Parameters:

fileName -

filenameToClassname

public static java.lang.String filenameToClassname(java.lang.String fileName)

This method checks and transforms the filename of a potential Class given by fileName.

Parameters:

fileName - is the filename.

Returns:

the according Java class-name for the given fileName if it is a class-file that is no anonymous Class, else null.

fixClassName

public static java.lang.String fixClassName(java.lang.String fileName)

This method checks and transforms the filename of a potential Class given by fileName.
Code written by Jorg Hohwiller for the m-m-m project (http://m-m-m.sf.net)

Parameters:

fileName - is the filename.

Returns:

the according Java class-name for the given fileName if it is a class-file that is no anonymous Class, else null.

getFile

public static java.io.File getFile(java.lang.String fullClassName)

Find the file (.jar or .class usually) that host this class.

Parameters:

fullClassName - The class name to look for.

Returns:

The File that contains this class. It will return null if the class was not loaded from a file or for any other error.

getMethod

@Deprecated
public static java.lang.reflect.Method getMethod(java.lang.Object object,
                                            java.lang.String methodName,
                                            boolean forceAccess,
                                            java.lang.Class<?>... parameterTypes)
                                          throws java.lang.SecurityException,
                                                 java.lang.NoSuchMethodException

Deprecated. Use ReflectionUtil.getMethod(Object, String, boolean, Class...) instead

Throws:

java.lang.SecurityException

java.lang.NoSuchMethodException

invokeMethod

@Deprecated
public static java.lang.Object invokeMethod(java.lang.Object object,
                                       java.lang.String methodName,
                                       boolean forceAccess,
                                       java.lang.Object... args)
                                     throws java.lang.SecurityException,
                                            java.lang.NoSuchMethodException,
                                            java.lang.IllegalArgumentException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.InvocationTargetException

Deprecated. Use ReflectionUtil.invokeMethod(Object, String, boolean, Object...) instead

Throws:

java.lang.SecurityException

java.lang.NoSuchMethodException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

getField

@Deprecated
public static java.lang.reflect.Field getField(java.lang.Object object,
                                          java.lang.String fieldName,
                                          boolean forceAccess)
                                        throws java.lang.SecurityException,
                                               java.lang.NoSuchFieldException

Deprecated. Use ReflectionUtil.getField(Object, String, boolean) instead

Throws:

java.lang.SecurityException

java.lang.NoSuchFieldException

getFieldObject

@Deprecated
public static java.lang.Object getFieldObject(java.lang.Object object,
                                         java.lang.String fieldName,
                                         boolean forceAccess)
                                       throws java.lang.IllegalArgumentException,
                                              java.lang.IllegalAccessException,
                                              java.lang.SecurityException,
                                              java.lang.NoSuchFieldException

Deprecated. Use ReflectionUtil.getFieldObject(Object, String, boolean) instead

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.SecurityException

java.lang.NoSuchFieldException