net.sf.mmm.util.pojo.descriptor.impl

Class PojoDescriptorBuilderImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.pojo.descriptor.base.AbstractPojoDescriptorBuilder

net.sf.mmm.util.pojo.descriptor.impl.PojoDescriptorBuilderImpl

All Implemented Interfaces:

PojoDescriptorBuilder

public class PojoDescriptorBuilderImpl
extends AbstractPojoDescriptorBuilder

This is the generic implementation of the PojoDescriptorBuilder interface.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private ExtendedPojoDescriptorDependencies	configuration
private PojoFieldIntrospector	fieldIntrospector
private PojoMethodIntrospector	methodIntrospector

Constructor Summary

Constructors

Constructor and Description
PojoDescriptorBuilderImpl() The constructor.
PojoDescriptorBuilderImpl(MapFactory mapFactory) The constructor.

Method Summary

Modifier and Type	Method and Description
protected <P> PojoDescriptorImpl<P>	createDescriptor(GenericType<P> pojoType) This method creates the pojo descriptor for the given pojoType.
protected void	doInitialize() This method performs the actual initialization.
protected Collection<PojoPropertyAccessorBuilder<?>>	getAccessorBuilders() This method gets the accessor-builders used to create the accessors for properties of a POJO.
protected ExtendedPojoDescriptorDependencies	getDependencies() This method gets the ExtendedPojoDescriptorDependencies.
protected PojoFieldIntrospector	getFieldIntrospector() This method gets the introspector used to find potential fields for accessing properties of a POJO.
protected PojoMethodIntrospector	getMethodIntrospector() This method gets the introspector used to find potential methods for accessing properties of a POJO.
protected ReflectionUtilLimited	getReflectionUtil() This method gets the instance of ReflectionUtilLimited.
private <P> void	introspectFields(Class<P> pojoClass, PojoDescriptorImpl<P> descriptor, List<AccessibleObject> nonPublicAccessibleObjects) Introspects the Fields of the given Class and adds them to the given PojoDescriptorImpl.
private <P> void	introspectMethods(Class<P> pojoClass, PojoDescriptorImpl<P> descriptor, List<AccessibleObject> nonPublicAccessibleObjects) Introspects the Methods of the given Class and adds them to the given PojoDescriptorImpl.
private boolean	isPublicAccessible(Member member) This method determines if the given Member is accessible or public (declared as public in a public class).
protected void	logDuplicateAccessor(PojoPropertyAccessor accessor, PojoPropertyAccessor duplicate) This method is called if the accessor given by duplicate was ignored because it has the same name and mode as the given accessor that is already registered.
private void	makeAccessible(List<AccessibleObject> nonPublicAccessibleObjects) Makes all AccessibleObjects in the given List accessible.
private <P> void	mergeDescriptorWithSuperClass(Class<P> pojoClass, PojoDescriptorImpl<P> descriptor) This method creates the PojoDescriptorImpl for the superclass of pojoClass and merges PojoPropertyDescriptorImpl from inherited properties.
private void	mergePropertyDescriptorWithSuperClass(PojoPropertyDescriptorImpl propertyDescriptor, PojoPropertyDescriptorImpl superPropertyDescriptor) This method merges the superPropertyDescriptor into the propertyDescriptor.
protected boolean	registerAccessor(PojoDescriptorImpl<?> descriptor, PojoPropertyAccessor accessor) This method registers the given accessor for the given descriptor.
void	setConfiguration(ExtendedPojoDescriptorDependencies configuration)
void	setFieldIntrospector(PojoFieldIntrospector introspector) This method sets the field-introspector.
void	setMethodIntrospector(PojoMethodIntrospector introspector) This method sets the method-introspector.

Methods inherited from class net.sf.mmm.util.pojo.descriptor.base.AbstractPojoDescriptorBuilder

getDescriptor, getDescriptor, getDescriptor, pojo2Map

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

configuration

private ExtendedPojoDescriptorDependencies configuration

methodIntrospector

private PojoMethodIntrospector methodIntrospector

fieldIntrospector

private PojoFieldIntrospector fieldIntrospector

Constructor Detail

PojoDescriptorBuilderImpl

public PojoDescriptorBuilderImpl()

The constructor. By default it only introspects methods that are public and NOT static.
ATTENTION:
You need to AbstractComponent.initialize() this component before it can be used.

PojoDescriptorBuilderImpl

public PojoDescriptorBuilderImpl(MapFactory mapFactory)

The constructor. By default it only introspects methods that are public and NOT static.
ATTENTION:
You need to AbstractComponent.initialize() this component before it can be used.

Parameters:

mapFactory - is the factory used to create the descriptor cache.

Method Detail

doInitialize

protected void doInitialize()

Description copied from class: AbstractComponent

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

getMethodIntrospector

protected PojoMethodIntrospector getMethodIntrospector()

This method gets the introspector used to find potential methods for accessing properties of a POJO.

Returns:

the introspector to use.

setMethodIntrospector

@Inject
public void setMethodIntrospector(PojoMethodIntrospector introspector)

This method sets the method-introspector.

Parameters:

introspector - the introspector to set.

getFieldIntrospector

protected PojoFieldIntrospector getFieldIntrospector()

This method gets the introspector used to find potential fields for accessing properties of a POJO.

Returns:

the introspector to use.

setFieldIntrospector

public void setFieldIntrospector(PojoFieldIntrospector introspector)

This method sets the field-introspector.

Parameters:

introspector - the introspector to set.

getAccessorBuilders

protected Collection<PojoPropertyAccessorBuilder<?>> getAccessorBuilders()

This method gets the accessor-builders used to create the accessors for properties of a POJO.

Returns:

the accessorBuilders.

getDependencies

protected ExtendedPojoDescriptorDependencies getDependencies()

This method gets the ExtendedPojoDescriptorDependencies.

Returns:

the ExtendedPojoDescriptorDependencies.

getReflectionUtil

protected ReflectionUtilLimited getReflectionUtil()

Description copied from class: AbstractPojoDescriptorBuilder

This method gets the instance of ReflectionUtilLimited.

Specified by:

getReflectionUtil in class AbstractPojoDescriptorBuilder

Returns:

the ReflectionUtilLimited.

setConfiguration

@Inject
public void setConfiguration(ExtendedPojoDescriptorDependencies configuration)

Parameters:

configuration - are the ExtendedPojoDescriptorDependencies .

registerAccessor

protected boolean registerAccessor(PojoDescriptorImpl<?> descriptor,
                                   PojoPropertyAccessor accessor)

This method registers the given accessor for the given descriptor.

Parameters:

descriptor - is the PojoDescriptor.

accessor - is the PojoPropertyAccessor to register.

Returns:

true if the given accessor has been registered or false if it has been ignored (it is a duplicate).

createDescriptor

protected <P> PojoDescriptorImpl<P> createDescriptor(GenericType<P> pojoType)

Description copied from class: AbstractPojoDescriptorBuilder

This method creates the pojo descriptor for the given pojoType.

Specified by:

createDescriptor in class AbstractPojoDescriptorBuilder

Type Parameters:

P - is the templated type of the pojoType.

Parameters:

pojoType - is the GenericType reflecting the Pojo.

Returns:

the descriptor used to get information about the properties of the according Pojo.

See Also:

PojoDescriptorBuilder.getDescriptor(java.lang.Class)

makeAccessible

private void makeAccessible(List<AccessibleObject> nonPublicAccessibleObjects)

Makes all AccessibleObjects in the given List accessible.

Parameters:

nonPublicAccessibleObjects - is the List where the non-public AccessibleObjects have been collected.

introspectFields

private <P> void introspectFields(Class<P> pojoClass,
                                  PojoDescriptorImpl<P> descriptor,
                                  List<AccessibleObject> nonPublicAccessibleObjects)

Introspects the Fields of the given Class and adds them to the given PojoDescriptorImpl.

Type Parameters:

P - is the generic type of pojoClass.

Parameters:

pojoClass - is the Class for the pojo type.

descriptor - is the PojoDescriptorImpl where to add PojoPropertyAccessors for detected properties.

nonPublicAccessibleObjects - is the List where to add non-public AccessibleObjects.

introspectMethods

private <P> void introspectMethods(Class<P> pojoClass,
                                   PojoDescriptorImpl<P> descriptor,
                                   List<AccessibleObject> nonPublicAccessibleObjects)

Introspects the Methods of the given Class and adds them to the given PojoDescriptorImpl.

Type Parameters:

P - is the generic type of pojoClass.

Parameters:

pojoClass - is the Class for the pojo type.

descriptor - is the PojoDescriptorImpl where to add PojoPropertyAccessors for detected properties.

nonPublicAccessibleObjects - is the List where to add non-public AccessibleObjects.

mergeDescriptorWithSuperClass

private <P> void mergeDescriptorWithSuperClass(Class<P> pojoClass,
                                               PojoDescriptorImpl<P> descriptor)

This method creates the PojoDescriptorImpl for the superclass of pojoClass and merges PojoPropertyDescriptorImpl from inherited properties.

Type Parameters:

P - is the generic type of pojoClass.

Parameters:

pojoClass - is the Class for the pojo type.

descriptor - is the PojoDescriptorImpl to merge.

mergePropertyDescriptorWithSuperClass

private void mergePropertyDescriptorWithSuperClass(PojoPropertyDescriptorImpl propertyDescriptor,
                                                   PojoPropertyDescriptorImpl superPropertyDescriptor)

This method merges the superPropertyDescriptor into the propertyDescriptor.

Parameters:

propertyDescriptor - is the PojoPropertyDescriptorImpl to build for the Pojo.

superPropertyDescriptor - is the super PojoPropertyDescriptorImpl to "inherit" from.

isPublicAccessible

private boolean isPublicAccessible(Member member)

This method determines if the given Member is accessible or public (declared as public in a public class).

Parameters:

member - is the Member to check.

Returns:

true if it can be accessed, false if it needs to be made accessible.

logDuplicateAccessor

protected void logDuplicateAccessor(PojoPropertyAccessor accessor,
                                    PojoPropertyAccessor duplicate)

This method is called if the accessor given by duplicate was ignored because it has the same name and mode as the given accessor that is already registered. This method does nothing. It may be overridden to do some debug logging.

Parameters:

accessor - is the accessor that is already registered.

duplicate - is the duplicate that has been ignored.