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

Interface PojoDescriptorGeneratorConfiguration

All Known Implementing Classes:

PojoDescriptorGeneratorConfigurationImpl

public interface PojoDescriptorGeneratorConfiguration

This is the configuration for PojoDescriptorGenerator and PojoDescriptorBuilderGenerator. If you want to define your own custom implementation, have a look at AbstractPojoDescriptorGenerator.createConfiguration() and PojoDescriptorGeneratorConfigurationImpl.getMarkerType().

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

isPojoTypeSupported(JClassType, TypeOracle)

Method Summary

Modifier and Type	Method and Description
String	getPojoTypeDescription()
com.google.gwt.core.ext.typeinfo.JClassType	getSupportedSuperType(com.google.gwt.core.ext.typeinfo.JClassType type, com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle) Determines the super-type that is supported.
boolean	isPojoTypeSupported(com.google.gwt.core.ext.typeinfo.JClassType type, com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle) This method determines if the given type will be supported and a PojoDescriptor implementation shall be generated.

Method Detail

isPojoTypeSupported

boolean isPojoTypeSupported(com.google.gwt.core.ext.typeinfo.JClassType type,
                            com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle)

This method determines if the given type will be supported and a PojoDescriptor implementation shall be generated.
ATTENTION:
You need to require some base class or marker-interface for your Pojos. Otherwise there is way too much clutter generated and your web-application will grow too big. So never consider to return true for every given type.

Parameters:

type - is the Pojo to check.

typeOracle - is the TypeOracle that may be used to resolve additional types (e.g. a marker interface).

Returns:

true if the given type is supported, false otherwise.

getSupportedSuperType

com.google.gwt.core.ext.typeinfo.JClassType getSupportedSuperType(com.google.gwt.core.ext.typeinfo.JClassType type,
                                                                  com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle)

Determines the super-type that is supported.

Parameters:

type - a supported type.

typeOracle - is the TypeOracle that may be used to resolve additional types (e.g. a marker interface).

Returns:

the direct super-type (typically JClassType.getSuperclass()) that is still supported or null if no such type exists.

getPojoTypeDescription

String getPojoTypeDescription()

Returns:

a description of the criteria for the supported Pojos. Only used for debugging.