com.cloudhopper.commons.util

Class MetaFieldUtil

java.lang.Object

com.cloudhopper.commons.util.MetaFieldUtil

public class MetaFieldUtil
extends Object

Utility class for generating an array of MetaFieldInfo objects at runtime by reflecting a class and searching for the MetaField annotation.
NOTE: This automatically handles unwrapping certain types such as an AtomicReference where the actual values you'd want to validate is the one contained within.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
MetaFieldUtil()

Method Summary

Methods

Modifier and Type	Method and Description
protected static MetaFieldInfo[]	internalToMetaFieldInfoArray(Class type, Object obj, String preFieldName, String postFieldName, String stringForNullValues, boolean ignoreAnnotatedName, boolean recursive) Optionally, recursively returns a new MetaFieldInfo array of all Fields annotated with MetaField in the object.
static MetaFieldInfo[]	toMetaFieldInfoArray(Class type, Object obj, String stringForNullValues, boolean ignoreAnnotatedName, boolean recursive) Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the object type.
static MetaFieldInfo[]	toMetaFieldInfoArray(Object obj) Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type.
static MetaFieldInfo[]	toMetaFieldInfoArray(Object obj, String stringForNullValues) Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type.
static MetaFieldInfo[]	toMetaFieldInfoArray(Object obj, String stringForNullValues, boolean ignoreAnnotatedName) Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type.
static String	toMetaFieldInfoString(Object obj) Creates a string for an object based on the MetaField annotations.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaFieldUtil

public MetaFieldUtil()

Method Detail

toMetaFieldInfoString

public static String toMetaFieldInfoString(Object obj)

Creates a string for an object based on the MetaField annotations.

Parameters:

obj - The object to search

Returns:

A string representing the current values of any MetaFields

toMetaFieldInfoArray

public static MetaFieldInfo[] toMetaFieldInfoArray(Object obj)

Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type. If the object is null, this method will return null. Will use the default "null" string representation of null values. NOTE: This method recursively searches the object.

Parameters:

obj - The runtime instance of the object to search. It must be an instance of the type. If its a subclass of the type, this method will only return MetaFields of the type passed in.

Returns:

The MetaFieldInfo array

toMetaFieldInfoArray

public static MetaFieldInfo[] toMetaFieldInfoArray(Object obj,
                                   String stringForNullValues)

Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type. If the object is null, this method will return null. NOTE: This method recursively searches the object.

Parameters:

obj - The runtime instance of the object to search. It must be an instance of the type. If its a subclass of the type, this method will only return MetaFields of the type passed in.

stringForNullValues - If a field is null, this is the string to swap in as the String value vs. "null" showing up.

Returns:

The MetaFieldInfo array

toMetaFieldInfoArray

public static MetaFieldInfo[] toMetaFieldInfoArray(Object obj,
                                   String stringForNullValues,
                                   boolean ignoreAnnotatedName)

Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the runtime object type. If the object is null, this method will return null. NOTE: This method recursively searches the object.

Parameters:

obj - The runtime instance of the object to search. It must be an instance of the type. If its a subclass of the type, this method will only return MetaFields of the type passed in.

stringForNullValues - If a field is null, this is the string to swap in as the String value vs. "null" showing up.

ignoreAnnotatedName - Whether to ignore the name of the MetaField and always return the field name instead. If false, this method will use the annotated name if it exists, otherwise it'll use the field name.

Returns:

The MetaFieldInfo array

toMetaFieldInfoArray

public static MetaFieldInfo[] toMetaFieldInfoArray(Class type,
                                   Object obj,
                                   String stringForNullValues,
                                   boolean ignoreAnnotatedName,
                                   boolean recursive)

Returns a new MetaFieldInfo array of all Fields annotated with MetaField in the object type. The object must be an instance of the type, otherwise this method may throw a runtime exception. Optionally, this method can recursively search the object to provide a deep view of the entire class.

Parameters:

type - The class type of the object

obj - The runtime instance of the object to search. It must be an instance of the type. If its a subclass of the type, this method will only return MetaFields of the type passed in.

stringForNullValues - If a field is null, this is the string to swap in as the String value vs. "null" showing up.

ignoreAnnotatedName - Whether to ignore the name of the MetaField and always return the field name instead. If false, this method will use the annotated name if it exists, otherwise it'll use the field name.

recursive - If true, this method will recursively search any fields to see if they also contain MetaField annotations. If they do, this method will include those in its returned array.

Returns:

The MetaFieldInfo array

internalToMetaFieldInfoArray

protected static MetaFieldInfo[] internalToMetaFieldInfoArray(Class type,
                                           Object obj,
                                           String preFieldName,
                                           String postFieldName,
                                           String stringForNullValues,
                                           boolean ignoreAnnotatedName,
                                           boolean recursive)

Optionally, recursively returns a new MetaFieldInfo array of all Fields annotated with MetaField in the object. If recursive is true, this will also search any fields in each class and add them in their order as well.

Parameters:

type - The class type of the obj (in case obj is null)

obj - The object to search. If this is null, will default values for each field to null.

appendFieldName - Will append this value to the name of the field (really for subfields)

stringForNullValues - If a field is null, this is the string to swap in as the String value vs. "null" showing up.

Returns:

The new MetaFieldInfo array