net.sf.mmm.util.pojo.base

Class PojoUtilImpl

java.lang.Object

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

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

net.sf.mmm.util.pojo.base.PojoUtilImpl

All Implemented Interfaces:

PojoUtil

public class PojoUtilImpl
extends AbstractLoggableComponent
implements PojoUtil

This class is a collection of utility functions for dealing with reflection.

Since:

7.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

getInstance()

Field Summary

Fields

Modifier and Type	Field and Description
private static PojoUtil	instance
private PojoDescriptorBuilder	pojoDescriptorBuilder
private PojoDescriptorBuilderFactory	pojoDescriptorBuilderFactory

Constructor Summary

Constructors

Constructor and Description
PojoUtilImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() This method performs the actual initialization.
protected void	doInitialized() This method is invoked at the end of the actual initialization.
static PojoUtil	getInstance() This method gets the singleton instance of this PojoUtil.
protected PojoDescriptorBuilder	getPojoDescriptorBuilder()
protected PojoDescriptorBuilderFactory	getPojoDescriptorBuilderFactory()
void	setPojoDescriptorBuilder(PojoDescriptorBuilder pojoDescriptorBuilder)
void	setPojoDescriptorBuilderFactory(PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory)
void	visitObjectRecursive(Object object, Filter<Object> visitor) This method recursively traverses all objects starting from the given Object via all properties and contents.
void	visitObjectRecursive(Object object, Filter<Object> visitor, boolean loopProtection) This method recursively traverses all objects starting from the given Object via all properties and contents.
protected void	visitObjectRecursive(Object object, Filter<Object> visitor, Set<HashKey<Object>> visitedSet)

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

createLogger, getLogger

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

getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

instance

private static PojoUtil instance

pojoDescriptorBuilderFactory

private PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory

pojoDescriptorBuilder

private PojoDescriptorBuilder pojoDescriptorBuilder

Constructor Detail

PojoUtilImpl

public PojoUtilImpl()

The constructor.

Method Detail

getInstance

public static PojoUtil getInstance()

This method gets the singleton instance of this PojoUtil.
ATTENTION:
Please read Cdi.GET_INSTANCE before using.

Returns:

the singleton instance.

doInitialized

protected void doInitialized()

Description copied from class: AbstractComponent

This method is invoked at the end of the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time after AbstractComponent.doInitialize() is completed and initialization-state has changed to initialized.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialized().

Overrides:

doInitialized in class AbstractComponent

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

getPojoDescriptorBuilderFactory

protected PojoDescriptorBuilderFactory getPojoDescriptorBuilderFactory()

Returns:

the instance of PojoDescriptorBuilderFactory.

setPojoDescriptorBuilderFactory

@Inject
public void setPojoDescriptorBuilderFactory(PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory)

Parameters:

pojoDescriptorBuilderFactory - is the instance of PojoDescriptorBuilderFactory to Inject.

getPojoDescriptorBuilder

protected PojoDescriptorBuilder getPojoDescriptorBuilder()

Returns:

the PojoDescriptorBuilder.

setPojoDescriptorBuilder

public void setPojoDescriptorBuilder(PojoDescriptorBuilder pojoDescriptorBuilder)

Parameters:

pojoDescriptorBuilder - is the PojoDescriptorBuilder to set.

visitObjectRecursive

public void visitObjectRecursive(Object object,
                                 Filter<Object> visitor)

Description copied from interface: PojoUtil

This method recursively traverses all objects starting from the given Object via all properties and contents. It simply delegates to PojoUtil.visitObjectRecursive(Object, Filter, boolean) using true for loopProtection.

Specified by:

visitObjectRecursive in interface PojoUtil

Parameters:

object - is the Object to traverse recursively.

visitor - is the Filter invoked for all traversed Objects. If an Object is not accepted by this Filter the recursion stops at this point.

visitObjectRecursive

public void visitObjectRecursive(Object object,
                                 Filter<Object> visitor,
                                 boolean loopProtection)

Description copied from interface: PojoUtil

This method recursively traverses all objects starting from the given Object via all properties and contents. It supports Collections, Maps, Object arrays, and Pojos.
ATTENTION:
This method will NOT traverse into primitive arrays for performance reasons. Simply realize this inside your visitor if you need it.

Specified by:

visitObjectRecursive in interface PojoUtil

Parameters:

object - is the Object to traverse recursively.

visitor - is the Filter invoked for all traversed Objects. If an Object is not accepted by this Filter the recursion stops at this point.

loopProtection - - true to collect all visited Objects in a Set in order to prevent infinity loops, false otherwise (to save performance if no loops are possible for the given Object).

visitObjectRecursive

protected void visitObjectRecursive(Object object,
                                    Filter<Object> visitor,
                                    Set<HashKey<Object>> visitedSet)

Parameters:

object - is the Object to traverse recursively.

visitor - is the Filter invoked for all traversed Objects. If an Object is not accepted by this Filter the recursion stops at this point.

visitedSet - is the Set where to collect all object to visit in order to prevent infinity loops or null to disable.

See Also:

visitObjectRecursive(Object, Filter, boolean)