org.pentaho.reporting.libraries.base.util
Class ObjectUtilities

java.lang.Object
  org.pentaho.reporting.libraries.base.util.ObjectUtilities

public final class ObjectUtilities
extends java.lang.Object

A collection of useful static utility methods for handling classes and object instantiation.

Author:

Thomas Morgner

Field Summary

static java.lang.String	CLASS_CONTEXT A constant for using the ClassContext as source for the classloader.
static java.lang.String	THREAD_CONTEXT A constant for using the TheadContext as source for the classloader.

Method Summary

static java.lang.Object	clone(java.lang.Object object) Returns a clone of the specified object, if it can be cloned, otherwise throws a CloneNotSupportedException.
static boolean	equal(java.lang.Object o1, java.lang.Object o2) Returns true if the two objects are equal OR both null.
static boolean	equalArray(java.lang.Object[] array1, java.lang.Object[] array2) Compares two arrays and determines if they are equal.
static java.lang.ClassLoader	getClassLoader() Returns the custom classloader or null, if no custom classloader is defined.
static java.lang.ClassLoader	getClassLoader(java.lang.Class c) Returns the classloader, which was responsible for loading the given class.
static java.lang.String	getClassLoaderSource() Returns the internal configuration entry, whether the classloader of the thread context or the context classloader should be used.
static java.net.URL	getResource(java.lang.String name, java.lang.Class c) Returns the resource specified by the absolute name.
static java.io.InputStream	getResourceAsStream(java.lang.String name, java.lang.Class context) Returns the inputstream for the resource specified by the absolute name.
static java.net.URL	getResourceRelative(java.lang.String name, java.lang.Class c) Returns the resource specified by the relative name.
static java.io.InputStream	getResourceRelativeAsStream(java.lang.String name, java.lang.Class context) Returns the inputstream for the resource specified by the relative name.
static boolean	isJDK14() Checks whether the current JDK is at least JDK 1.4.
static java.lang.Object	loadAndInstantiate(java.lang.String className, java.lang.Class source) Deprecated. This class is not typesafe and instantiates the specified object without any additional checks.
static java.lang.Object	loadAndInstantiate(java.lang.String className, java.lang.Class source, java.lang.Class type) Tries to create a new instance of the given class.
static void	setClassLoader(java.lang.ClassLoader classLoader) Redefines the custom classloader.
static void	setClassLoaderSource(java.lang.String classLoaderSource) Defines the internal configuration entry, whether the classloader of the thread context or the context classloader should be used.

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_CONTEXT

public static final java.lang.String THREAD_CONTEXT

A constant for using the TheadContext as source for the classloader.

See Also:

Constant Field Values

CLASS_CONTEXT

public static final java.lang.String CLASS_CONTEXT

A constant for using the ClassContext as source for the classloader.

See Also:

Constant Field Values

Method Detail

getClassLoaderSource

public static java.lang.String getClassLoaderSource()

Returns the internal configuration entry, whether the classloader of the thread context or the context classloader should be used.

Returns:

the classloader source, either THREAD_CONTEXT or CLASS_CONTEXT.

setClassLoaderSource

public static void setClassLoaderSource(java.lang.String classLoaderSource)

Defines the internal configuration entry, whether the classloader of the thread context or the context classloader should be used.

This setting can only be defined using the API, there is no safe way to put this into an external configuration file.

Parameters:

classLoaderSource - the classloader source, either THREAD_CONTEXT or CLASS_CONTEXT.

equal

public static boolean equal(java.lang.Object o1,
                            java.lang.Object o2)

Returns true if the two objects are equal OR both null.

Parameters:

o1 - object 1 (null permitted).

o2 - object 2 (null permitted).

Returns:

true or false.

clone

public static java.lang.Object clone(java.lang.Object object)
                              throws java.lang.CloneNotSupportedException

Returns a clone of the specified object, if it can be cloned, otherwise throws a CloneNotSupportedException.

Parameters:

object - the object to clone (null not permitted).

Returns:

A clone of the specified object.

Throws:

java.lang.CloneNotSupportedException - if the object cannot be cloned.

setClassLoader

public static void setClassLoader(java.lang.ClassLoader classLoader)

Redefines the custom classloader.

Parameters:

classLoader - the new classloader or null to use the default.

getClassLoader

public static java.lang.ClassLoader getClassLoader()

Returns the custom classloader or null, if no custom classloader is defined.

Returns:

the custom classloader or null to use the default.

getClassLoader

public static java.lang.ClassLoader getClassLoader(java.lang.Class c)

Returns the classloader, which was responsible for loading the given class.

Parameters:

c - the classloader, either an application class loader or the boot loader.

Returns:

the classloader, never null.

Throws:

java.lang.SecurityException - if the SecurityManager does not allow to grab the context classloader.

getResource

public static java.net.URL getResource(java.lang.String name,
                                       java.lang.Class c)

Returns the resource specified by the absolute name.

Parameters:

name - the name of the resource

c - the source class

Returns:

the url of the resource or null, if not found.

getResourceRelative

public static java.net.URL getResourceRelative(java.lang.String name,
                                               java.lang.Class c)

Returns the resource specified by the relative name.

Parameters:

name - the name of the resource relative to the given class

c - the source class

Returns:

the url of the resource or null, if not found.

getResourceAsStream

public static java.io.InputStream getResourceAsStream(java.lang.String name,
                                                      java.lang.Class context)

Returns the inputstream for the resource specified by the absolute name.

Parameters:

name - the name of the resource

context - the source class

Returns:

the url of the resource or null, if not found.

getResourceRelativeAsStream

public static java.io.InputStream getResourceRelativeAsStream(java.lang.String name,
                                                              java.lang.Class context)

Returns the inputstream for the resource specified by the relative name.

Parameters:

name - the name of the resource relative to the given class

context - the source class

Returns:

the url of the resource or null, if not found.

loadAndInstantiate

public static java.lang.Object loadAndInstantiate(java.lang.String className,
                                                  java.lang.Class source)

Deprecated. This class is not typesafe and instantiates the specified object without any additional checks.

Tries to create a new instance of the given class. This is a short cut for the common bean instantiation code.

Parameters:

className - the class name as String, never null.

source - the source class, from where to get the classloader.

Returns:

the instantiated object or null, if an error occured.

loadAndInstantiate

public static java.lang.Object loadAndInstantiate(java.lang.String className,
                                                  java.lang.Class source,
                                                  java.lang.Class type)

Tries to create a new instance of the given class. This is a short cut for the common bean instantiation code. This method is a type-safe method and will not instantiate the class unless it is an instance of the given type.

Parameters:

className - the class name as String, never null.

source - the source class, from where to get the classloader.

type - the expected type of the object that is being instantiated.

Returns:

the instantiated object, which is guaranteed to be of the given type, or null, if an error occured.

isJDK14

public static boolean isJDK14()

Checks whether the current JDK is at least JDK 1.4.

Returns:

true, if the JDK has been recognized as JDK 1.4, false otherwise.

equalArray

public static boolean equalArray(java.lang.Object[] array1,
                                 java.lang.Object[] array2)

Compares two arrays and determines if they are equal. This method allows to pass null null references for any of the arrays.

Parameters:

array1 - the first array to compare.

array2 - the second array to compare.

Returns:

true, if both arrays are equal or both arrays are null, false otherwise.