org.josef.util

Class ClassUtil

java.lang.Object

org.josef.util.ClassUtil

@Status(stage=DEVELOPMENT,
        unitTests=PARTIAL)
public final class ClassUtil
extends Object

Generic utility class directly related to Class.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static ClassLoader	getClassLoader() Gets the current class loader.
static ClassLoader	getClassLoader(Class<?> theClass) Gets the class loader of the supplied class.
static ClassLoader	getClassLoader(Object theObject) Gets the class loader of the supplied object.
static CompareField[]	getCompareFields(Class<?> theClass) Gets all the possible fields that can be compared upon in the supplied class (and its super classes) plus the fields that can be reached from the supplied class.
static String	getSimpleClassNameOfInstance(Object object) Convenience method to get the simple name of the class of the supplied object.
static boolean	isMultipleObjectClass(Class<?> theClass) Determines whether the supplied class is capable of storing multiple objects or not.
static boolean	isToStringOverridden(Object object) Determines whether the toString() method of the class of the supplied object has been overridden.
static boolean	isValueClass(Class<?> theClass) Determines whether the supplied class is a value class or not.

Methods inherited from class java.lang.Object

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

Method Detail

getClassLoader

public static ClassLoader getClassLoader()

Gets the current class loader.

Returns:

The current class loader.

getClassLoader

public static ClassLoader getClassLoader(Class<?> theClass)

Gets the class loader of the supplied class.

Parameters:

theClass - The class to get the class loader for.

Returns:

The class loader of the supplied class or the System Class Loader when the supplied class' class loader could not be determined.

Throws:

NullPointerException - When the supplied class is null.

getClassLoader

public static ClassLoader getClassLoader(Object theObject)

Gets the class loader of the supplied object.

Parameters:

theObject - The object to get the class loader for.

Returns:

The class loader of the supplied object or the System Class Loader when the supplied class' class loader could not be determined.

Throws:

NullPointerException - When the supplied object is null.

getSimpleClassNameOfInstance

public static String getSimpleClassNameOfInstance(Object object)

Convenience method to get the simple name of the class of the supplied object.

Parameters:

object - The object to determine its simple class name of.

Returns:

The simple class name of the supplied object.

Throws:

NullPointerException - When the supplied object is null.

See Also:

Class.getSimpleName()

isValueClass

public static boolean isValueClass(Class<?> theClass)

Determines whether the supplied class is a value class or not.
A value class is a class that wraps a value.

Parameters:

theClass - The class to check.

Returns:

True When the supplied theClass is a value class, otherwise false.

Throws:

NullPointerException - When the supplied theClass is null.

isMultipleObjectClass

public static boolean isMultipleObjectClass(Class<?> theClass)

Determines whether the supplied class is capable of storing multiple objects or not.
Arrays, Maps, Lists and Sets are classes capable of storing multiple objects.

Parameters:

theClass - The class to check.

Returns:

True When the supplied theClass is capable of storing multiple objects, otherwise false.

Throws:

NullPointerException - When the supplied theClass is null.

getCompareFields

public static CompareField[] getCompareFields(Class<?> theClass)

Gets all the possible fields that can be compared upon in the supplied class (and its super classes) plus the fields that can be reached from the supplied class.
To ignore a field, annotate its getter with NotComparable.
Note: CompareFields use Methods to access the actual field, this is why this method actually accesses the different getters instead of directly accessing the actual fields.

Parameters:

theClass - The class to get the fields from.

Returns:

All the possible fields of the supplied class, that can be compared upon.

isToStringOverridden

public static boolean isToStringOverridden(Object object)

Determines whether the toString() method of the class of the supplied object has been overridden.

Parameters:

object - The object to check for an overridden toString() at the class level.

Returns:

True when the class of the supplied object overrides toString(), otherwise false is returned.
False is also returned when the supplied object is null.