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

Class PojoDescriptorGeneratorConfigurationImpl

java.lang.Object

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

All Implemented Interfaces:

PojoDescriptorGeneratorConfiguration

public class PojoDescriptorGeneratorConfigurationImpl
extends Object
implements PojoDescriptorGeneratorConfiguration

This is the configuration for PojoDescriptorGenerator and PojoDescriptorBuilderGenerator. It defines the marker class or interface

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.core.ext.typeinfo.JClassType	markerType

Constructor Summary

Constructors

Constructor and Description
PojoDescriptorGeneratorConfigurationImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
protected com.google.gwt.core.ext.typeinfo.JClassType	getMarkerClassType(com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle)
protected Class<?>	getMarkerType() This method gets the Class reflecting the class or interface used as markers for objects for POJOs where reflection should be supported via PojoDescriptorBuilder.
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.
protected boolean	isInterfaceSupported() Determines if if interfaces are 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.

Methods inherited from class java.lang.Object

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

Field Detail

markerType

private com.google.gwt.core.ext.typeinfo.JClassType markerType

See Also:

isPojoTypeSupported(JClassType, TypeOracle)

Constructor Detail

PojoDescriptorGeneratorConfigurationImpl

public PojoDescriptorGeneratorConfigurationImpl()

The constructor.

Method Detail

isPojoTypeSupported

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

Description copied from interface: PojoDescriptorGeneratorConfiguration

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.

Specified by:

isPojoTypeSupported in interface PojoDescriptorGeneratorConfiguration

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.

getMarkerClassType

protected final com.google.gwt.core.ext.typeinfo.JClassType getMarkerClassType(com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle)

Parameters:

typeOracle - is the TypeOracle.

Returns:

the JClassType for getMarkerType().

getSupportedSuperType

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

Description copied from interface: PojoDescriptorGeneratorConfiguration

Determines the super-type that is supported.

Specified by:

getSupportedSuperType in interface PojoDescriptorGeneratorConfiguration

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.

isInterfaceSupported

protected boolean isInterfaceSupported()

Determines if if interfaces are supported. This method does NOT affect the marker type that may also be an interface.

Returns:

true if interfaces are supported, false otherwise.

getPojoTypeDescription

public String getPojoTypeDescription()

Specified by:

getPojoTypeDescription in interface PojoDescriptorGeneratorConfiguration

Returns:

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

getMarkerType

protected Class<?> getMarkerType()

This method gets the Class reflecting the class or interface used as markers for objects for POJOs where reflection should be supported via PojoDescriptorBuilder.

Returns:

the marker Class.