org.hibernate.search.util.impl

Class ReflectionHelper

java.lang.Object

org.hibernate.search.util.impl.ReflectionHelper

public abstract class ReflectionHelper
extends Object

Author:

Emmanuel Bernard, Hardy Ferentschik

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsSearchAnnotations(org.hibernate.annotations.common.reflection.XClass mappedClass) Checks whether the specified class contains any Search specific annotations.
static Object	createInstance(Class<?> clazz, boolean checkForFactoryAnnotation) Creates an instance of the specified class and returns it.
static List<org.hibernate.annotations.common.reflection.XClass>	createXClassHierarchy(org.hibernate.annotations.common.reflection.XClass clazz) Creates the class hierarchy for a given XClass.
static String	getAttributeName(org.hibernate.annotations.common.reflection.XMember member, String name) Get attribute name out of member unless overridden by name.
static Object	getMemberValue(Object bean, org.hibernate.annotations.common.reflection.XMember getter)
static boolean	isSearchAnnotation(Annotation annotation) Checks if the annotation is a Search annotation by comparing the package of the annotation.
static void	setAccessible(AccessibleObject member) Always use this method to set accessibility regardless of the visibility.
static void	setAccessible(org.hibernate.annotations.common.reflection.XMember member) Always use this method to set accessibility regardless of the visibility.

Methods inherited from class java.lang.Object

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

Method Detail

getAttributeName

public static String getAttributeName(org.hibernate.annotations.common.reflection.XMember member,
                      String name)

Get attribute name out of member unless overridden by name.

Parameters:

member - XMember from which to extract the name.

name - Override value which will be returned in case it is not empty.

Returns:

attribute name out of member unless overridden by name.

setAccessible

public static void setAccessible(org.hibernate.annotations.common.reflection.XMember member)

Always use this method to set accessibility regardless of the visibility.

setAccessible

public static void setAccessible(AccessibleObject member)

Always use this method to set accessibility regardless of the visibility.

getMemberValue

public static Object getMemberValue(Object bean,
                    org.hibernate.annotations.common.reflection.XMember getter)

createXClassHierarchy

public static List<org.hibernate.annotations.common.reflection.XClass> createXClassHierarchy(org.hibernate.annotations.common.reflection.XClass clazz)

Creates the class hierarchy for a given XClass.

Parameters:

clazz - the class for which to create the hierarchy

Returns:

the list of classes in the hierarchy starting at java.lang.Object

containsSearchAnnotations

public static boolean containsSearchAnnotations(org.hibernate.annotations.common.reflection.XClass mappedClass)

Checks whether the specified class contains any Search specific annotations.

Parameters:

mappedClass - the XClass to check for Search annotations

Returns:

Returns true if the class contains at least one Search annotation, false otherwise

isSearchAnnotation

public static boolean isSearchAnnotation(Annotation annotation)

Checks if the annotation is a Search annotation by comparing the package of the annotation.

Parameters:

annotation - the annotation to check

Returns:

Returns true if the annotation is a Search annotation, false otherwise

createInstance

public static Object createInstance(Class<?> clazz,
                    boolean checkForFactoryAnnotation)

Creates an instance of the specified class and returns it. If checkForFactoryAnnotation == true, the created instance is checked for a @Factory annotated method. If one exists the factory method is invoked and the return value returns as expected instances.

Parameters:

clazz - the class to instantiate

checkForFactoryAnnotation - whether to check for @Factory annotated methods

Returns:

the created instance