com.cloudhopper.commons.util

Class ClassUtil

java.lang.Object

com.cloudhopper.commons.util.ClassUtil

public class ClassUtil
extends Object

This class implements utilities for working with classes.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer), john woolf (twitter: @jwoolf330 or http://twitter.com/jwoolf330)

Constructor Summary

Constructors

Constructor and Description
ClassUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	findEnumConstant(Class<?> type, String constantName) Finds an instance of an Enum constant on a class.
static Object	findEnumConstant(Class<?> type, String constantName, boolean caseSensitive) Finds an instance of an Enum constant on a class.
static Method[]	getBeanMethods(Class<?> type, String propertyName, Class<?> propertyType, boolean caseSensitive) Gets the methods within this class that implements public "bean" methods (get and set) for the property name.
static Class<?>[]	getClassHierarchy(Class<?> type) Returns an array of class objects representing the entire class hierarchy with the most-super class as the first element followed by all subclasses in the order they are declared.
static Method	getMethod(Class<?> type, String name, Class<?> returnType, Class<?> paramType, boolean caseSensitive) Gets the public method within the type that matches the method name, return type, and single parameter type.
static boolean	hasBeanMethods(Class<?> type, String propertyName, Class<?> propertyType, boolean caseSensitive) Checks if the class implements public "bean" methods (get and set) for the name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassUtil

public ClassUtil()

Method Detail

findEnumConstant

public static Object findEnumConstant(Class<?> type,
                      String constantName)

Finds an instance of an Enum constant on a class. Useful for safely getting the value of an enum constant without an exception being thrown like the Enum.valueOf() method causes. Searches for enum constant where case is sensitive.

findEnumConstant

public static Object findEnumConstant(Class<?> type,
                      String constantName,
                      boolean caseSensitive)

Finds an instance of an Enum constant on a class. Useful for safely getting the value of an enum constant without an exception being thrown like the Enum.valueOf() method causes. Also, this method optionally allows the caller to choose whether case matters during the search.

getClassHierarchy

public static Class<?>[] getClassHierarchy(Class<?> type)

Returns an array of class objects representing the entire class hierarchy with the most-super class as the first element followed by all subclasses in the order they are declared. This method does not include the generic Object type in its list. If this class represents the Object type, this method will return a zero-size array.

hasBeanMethods

public static boolean hasBeanMethods(Class<?> type,
                     String propertyName,
                     Class<?> propertyType,
                     boolean caseSensitive)

Checks if the class implements public "bean" methods (get and set) for the name. For example, for a name such as "firstName", this method will check if the class has both getFirstName() and setFirstName() methods. Also, this method will validate the return type matches the paramType on the getXXX() method and that the setXXX() method only accepts that paramType. The search is optionally case sensitive.

Parameters:

type - The class to search

propertyName - The property name to search for, if "firstName", then this method will internally add the "get" and "set" to the beginning.

propertyType - The class type of the property

caseSensitive - If the search is case sensitive or not

Returns:

True if the "bean" methods are correct, otherwise false.

getBeanMethods

public static Method[] getBeanMethods(Class<?> type,
                      String propertyName,
                      Class<?> propertyType,
                      boolean caseSensitive)
                               throws IllegalAccessException,
                                      NoSuchMethodException

Gets the methods within this class that implements public "bean" methods (get and set) for the property name. Returns an array of methods where index=0 is the get method and index=1 is the set method. For example, for a name such as "firstName", this method will check if the class has both getFirstName() and setFirstName() methods. Also, this method will validate the return type matches the propertyType on the getXXX() method and that the setXXX() method only accepts that propertyType. The search is optionally case sensitive.

Parameters:

type - The class to search

propertyName - The name to search for

paramType - The class type of the property

caseSensitive - If the search is case sensitive or not

Returns:

An array of Methods were index=0 is the get method and index=1 is the set method

Throws:

IllegalAccessException - If the method was found, but is not public.

NoSuchMethodException - If the method was not found

getMethod

public static Method getMethod(Class<?> type,
               String name,
               Class<?> returnType,
               Class<?> paramType,
               boolean caseSensitive)
                        throws IllegalAccessException,
                               NoSuchMethodException

Gets the public method within the type that matches the method name, return type, and single parameter type. Optionally is a case sensitive search. Useful for searching for "bean" methods on classes.

Parameters:

type - The class to search for the method

name - The name of the method to search for

returnType - The expected return type or null if its expected to be a void method

paramType - The expected parameter type or null if no parameters are expected

caseSensitive - True if its a case sensitive search, otherwise false

Returns:

The method matching the search criteria

Throws:

IllegalAccessException - If the method was found, but is not public.

NoSuchMethodException - If the method was not found