com.toolsverse.util

Class ClassUtils

Object

com.toolsverse.util.ClassUtils

public final class ClassUtils
extends Object

The collection of the static methods for loading classes from the various external resources, add classes to the classpath, etc.

Since:

2.0

Version:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	INNER_CLASS_SEPARATOR The inner class separator String: "$".
static char	INNER_CLASS_SEPARATOR_CHAR The inner class separator character: '$' == 36.
static String	PACKAGE_SEPARATOR The package separator String: ".".
static char	PACKAGE_SEPARATOR_CHAR The package separator character: '.' == 46.

Constructor Summary

Constructors

Constructor and Description
ClassUtils()

Method Summary

Modifier and Type	Method and Description
static void	addFolderToClassPath(String folder, String pattern) Adds the all files in the folder, including sub folder which match the pattern to the class path.
static void	addToClassPath(File file) Adds file to the class path.
static void	addToClassPath(String fileName) Adds file name to to the class path.
static void	addToClassPath(String name, String delimiter) Adds multiple files the to class path.
static void	addToClassPath(URL url) Adds url to the class path.
static boolean	classExists(String className) Checks if class with given name exists
static String	className2Web(String className) Converts class name to the form which can be used by the Wings framework as a component name.
static Object	clone(Object obj) Deep clones object.
static List<Class<?>>	getClasses(String packageName, Class<?> classCastTo, boolean recursively) Gets the list of the classes in the package.
static List<Class<?>>	getClasses(String libPath, String pluginPath, String packageName, Class<?> classCastTo, Map<String,String> addedJars) Gets the list of classes in the package first, then adds classes in the plugin path and finally adds classes in the lib path.
static List<Class<?>>	getClassesInPackage(String jarFileName, String packageName, Class<?> classCastTo, Map<String,String> addedJars) Gets the list of the classes in the package.
static List<Class<?>>	getClassesInPackageInFolder(String folderName, String packageName, Class<?> classCastTo, Map<String,String> addedJars) Gets the list of the classes in the package located in the jar files in the folder.
static List<Class<?>>	getClassesInPackageInFolder(String folderName, String fileName, String packageName, Class<?> classCastTo, Map<String,String> addedJars) Gets the list of the classes in the package located in the jar files in the folder.
static List<Class<?>>	getClassesInPackageInFolder(String folderName, String fileName, String packageName, Class<?> classCastTo, Map<String,String> addedJars, String ext) Gets the list of the classes in the package located in the jar files in the folder.
static List<String>	getFilesInPackage(String pattren, Class<?> clazz) Gets the files in the package using given pattern.
static String	getShortClassName(String className) Gets the class name minus the package name from a String.

Methods inherited from class Object

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

Field Detail

PACKAGE_SEPARATOR_CHAR

public static final char PACKAGE_SEPARATOR_CHAR

The package separator character: '.' == 46.

See Also:

Constant Field Values

PACKAGE_SEPARATOR

public static final String PACKAGE_SEPARATOR

The package separator String: ".".

INNER_CLASS_SEPARATOR_CHAR

public static final char INNER_CLASS_SEPARATOR_CHAR

The inner class separator character: '$' == 36.

See Also:

Constant Field Values

INNER_CLASS_SEPARATOR

public static final String INNER_CLASS_SEPARATOR

The inner class separator String: "$".

Constructor Detail

ClassUtils

public ClassUtils()

Method Detail

addFolderToClassPath

public static void addFolderToClassPath(String folder,
                                        String pattern)

Adds the all files in the folder, including sub folder which match the pattern to the class path.

Parameters:

folder - the folder

pattern - the pattern

addToClassPath

public static void addToClassPath(File file)
                           throws Exception

Adds file to the class path.

Parameters:

file - the file to add

Throws:

Exception - if anything goes wrong

addToClassPath

public static void addToClassPath(String fileName)
                           throws Exception

Adds file name to to the class path.

Parameters:

fileName - the file name to add

Throws:

Exception - if anything goes wrong

addToClassPath

public static void addToClassPath(String name,
                                  String delimiter)
                           throws Exception

Adds multiple files the to class path.

Parameters:

name - the string where individual file names divided by delimiter

delimiter - the delimiter between file names

Throws:

Exception - if anything goes wrong

addToClassPath

public static void addToClassPath(URL url)
                           throws Exception

Adds url to the class path.

Parameters:

url - the url to add

Throws:

Exception - if anything goes wrong

classExists

public static boolean classExists(String className)
                           throws ClassNotFoundException

Checks if class with given name exists

Parameters:

className - the class name

Returns:

true if class exists

Throws:

ClassNotFoundException

className2Web

public static String className2Web(String className)

Converts class name to the form which can be used by the Wings framework as a component name.

Example: com.toolsverse.utils.ClassC --> comtoolsverseutilsClassC

Parameters:

className - the name of the class

Returns:

the converted string

clone

public static Object clone(Object obj)
                    throws Exception

Deep clones object.

Parameters:

obj - the object to clone

Returns:

the cloned object

Throws:

Exception - if anything goes wrong

getClasses

public static List<Class<?>> getClasses(String packageName,
                                        Class<?> classCastTo,
                                        boolean recursively)

Gets the list of the classes in the package. Each class must be actual .class file and an instance of the classCastTo argument.

Example: getClasses("com.toolsverse.pkg", ClassA.class, true) --> returns the list of the classes which can be cast to ClassA in the package com.toolsverse.pkg and sub packages

Parameters:

packageName - the name of the package

classCastTo - the class to check against.

recursively - if true include classes in sub packages

Returns:

the list of the classes in the package

getClasses

public static List<Class<?>> getClasses(String libPath,
                                        String pluginPath,
                                        String packageName,
                                        Class<?> classCastTo,
                                        Map<String,String> addedJars)

Gets the list of classes in the package first, then adds classes in the plugin path and finally adds classes in the lib path. All discovered jars will be added to the class path.
The purpose of this function is to dynamically load classes from the structure in the file system, similar to the following:
%home%\classes
com\toolseverse\pkg (package )
ClassA.class
ClassB.class
%home%\plugin (plugin path)
JarA.jar
JarB.jar
%home%\lib (lib path)
JarC.jar
JarD.jar

Function works differently on the client where it is possible to have separate lib and plugin folders and on the server where all jars usually placed in the single lib folder.

Parameters:

libPath - the path to the core jars. It is possible to use file name wildcards

pluginPath - the path to the plugin jars. It is possible to use file name wildcards

packageName - the name of the package

classCastTo - the class to check against.

addedJars - the jar files already added to the class path

Returns:

the list of the classes

getClassesInPackage

public static List<Class<?>> getClassesInPackage(String jarFileName,
                                                 String packageName,
                                                 Class<?> classCastTo,
                                                 Map<String,String> addedJars)

Gets the list of the classes in the package. Package must be located in the jar file. Each class must be an instance of the classCastTo argument. Jar file will be added to the class path.

Parameters:

jarFileName - the name of the jar file

packageName - the name of the package

classCastTo - the class to check against.

addedJars - the jar files already added to the class path

Returns:

the list of classes in the package

getClassesInPackageInFolder

public static List<Class<?>> getClassesInPackageInFolder(String folderName,
                                                         String packageName,
                                                         Class<?> classCastTo,
                                                         Map<String,String> addedJars)

Gets the list of the classes in the package located in the jar files in the folder. All discovered jars will be added to the class path.

Parameters:

folderName - the name of the folder with jar files

packageName - the name of the package

classCastTo - the class to check against.

addedJars - the jar files already added to the class path

Returns:

the list of the classes in the package

getClassesInPackageInFolder

public static List<Class<?>> getClassesInPackageInFolder(String folderName,
                                                         String fileName,
                                                         String packageName,
                                                         Class<?> classCastTo,
                                                         Map<String,String> addedJars)

Gets the list of the classes in the package located in the jar files in the folder. Jar files can be limited to the fileName (wildcards are allowed). All discovered jars will be added to the class path.

Parameters:

folderName - the name of the folder with jar files

fileName - the name of the jar file. Wildcards are allowed. If equals to null *.jar will be used.

packageName - the name of the package

classCastTo - the class to check against.

addedJars - the jar files already added to the class path

Returns:

the list of the classes in the package

getClassesInPackageInFolder

public static List<Class<?>> getClassesInPackageInFolder(String folderName,
                                                         String fileName,
                                                         String packageName,
                                                         Class<?> classCastTo,
                                                         Map<String,String> addedJars,
                                                         String ext)

Gets the list of the classes in the package located in the jar files in the folder. Jar files can be limited to the fileName (wildcards are allowed). All discovered jars will be added to the class path.

Parameters:

folderName - the name of the folder with jar files

fileName - the name of the jar file. Wildcards are allowed. If equals to null *.jar will be used.

packageName - the name of the package

classCastTo - the class to check against.

addedJars - the jar files already added to the class path

ext - the extension of the control file

Returns:

the list of the classes in the package

getFilesInPackage

public static List<String> getFilesInPackage(String pattren,
                                             Class<?> clazz)
                                      throws Exception

Gets the files in the package using given pattern. Pattern can include wildcards.

Parameters:

pattren - the pattern

clazz - any class which lives in the the folder

Returns:

the files from package

Throws:

Exception - the exception

getShortClassName

public static String getShortClassName(String className)

Gets the class name minus the package name from a String.

The string passed in is assumed to be a class name - it is not checked.

Note that this method differs from Class.getSimpleName() in that this will return "Map.Entry" whilst the java.lang.Class variant will simply return "Entry".

Parameters:

className - the className to get the short name for

Returns:

the class name of the class without the package name or an empty string