Module org.eclipse.persistence.moxy

Package org.eclipse.persistence.jaxb.compiler

Class Generator

java.lang.Object

org.eclipse.persistence.jaxb.compiler.Generator

public class Generator
extends Object

INTERNAL:

Purpose:The purpose of this class is to act as an entry point into the TopLink JAXB 2.0 Generation framework

Responsibilities:

• Run initial processing on a list of classes to create TypeInfo meta data
• Provide API to generate Schema Files
• Provide API to generate a TopLink Project
• Act as an integration point with WebServices

This class acts as an entry point into JAXB 2.0 Generation. A Generator is created with a specific set of JAXB 2.0 Annotated classes and then performs actions on those, such as generating schema files, or generating TopLink Projects. Additional information is returned from the schema generation methods as a means of integration with WebServices.

Since:

Oracle TopLink 11.1.1.0.0

See Also:

• AnnotationsProcessor
• MappingsGenerator
• SchemaGenerator

Constructor Summary

Constructors

Constructor	Description
Generator(JavaModelInput jModelInput)	This constructor creates a Helper using the JavaModelInput instance's JavaModel.
Generator(JavaModelInput jModelInput, Map<String,XmlBindings> xmlBindings, ClassLoader cLoader, String defaultTargetNamespace, boolean enableXmlAccessorFactory)	This constructor will process and apply the given XmlBindings as appropriate.
Generator(JavaModelInput jModelInput, TypeMappingInfo[] typeMappingInfos, JavaClass[] javaClasses, Map<Type,TypeMappingInfo> typeToTypeMappingInfo, String defaultTargetNamespace)	This constructor creates a Helper using the JavaModelInput instance's JavaModel and a map of javaclasses that were generated from Type objects.
Generator(JavaModelInput jModelInput, TypeMappingInfo[] typeMappingInfos, JavaClass[] javaClasses, Map<Type,TypeMappingInfo> typeToTypeMappingInfo, Map<String,XmlBindings> xmlBindings, ClassLoader cLoader, String defaultTargetNamespace, boolean enableXmlAccessorFactory)	This constructor will process and apply the given XmlBindings as appropriate.

Method Summary

Modifier and Type	Method	Description
CoreProject	generateProject()
Collection<Schema>	generateSchema()
Map<String,SchemaTypeInfo>	generateSchemaFiles(SchemaOutputResolver outputResolver, Map<QName,Type> additionalGlobalElements)
Map<String,SchemaTypeInfo>	generateSchemaFiles(String schemaPath, Map<QName,Type> additionalGlobalElements)
AnnotationsProcessor	getAnnotationsProcessor()
MappingsGenerator	getMappingsGenerator()
Map<String,MarshalCallback>	getMarshalCallbacks()
Map<Type,TypeMappingInfo>	getTypeToTypeMappingInfo()
Map<String,UnmarshalCallback>	getUnmarshalCallbacks()
boolean	hasMarshalCallbacks()
boolean	hasUnmarshalCallbacks()
void	postInitialize()	This event is called when mappings generation is completed, and provides a chance to deference anything that is no longer needed (to reduce the memory footprint of this object).
void	setTypeToTypeMappingInfo(Map<Type,TypeMappingInfo> typesToTypeMapping)

Methods inherited from class java.lang.Object

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

Constructor Details

Generator

public Generator(JavaModelInput jModelInput)

This constructor creates a Helper using the JavaModelInput instance's JavaModel. Annotations are processed here as well.

Generator

public Generator(JavaModelInput jModelInput,
 Map<String,XmlBindings> xmlBindings,
 ClassLoader cLoader,
 String defaultTargetNamespace,
 boolean enableXmlAccessorFactory)

This constructor will process and apply the given XmlBindings as appropriate. Classes declared in the bindings will be amalgamated with any classes in the JavaModelInput. If xmlBindings is null or empty, AnnotationsProcessor will be used to process annotations as per usual.

Parameters:

xmlBindings - map of XmlBindings keyed on package name

Generator

public Generator(JavaModelInput jModelInput,
 TypeMappingInfo[] typeMappingInfos,
 JavaClass[] javaClasses,
 Map<Type,TypeMappingInfo> typeToTypeMappingInfo,
 String defaultTargetNamespace)

This constructor creates a Helper using the JavaModelInput instance's JavaModel and a map of javaclasses that were generated from Type objects. Annotations are processed here as well.

Generator

public Generator(JavaModelInput jModelInput,
 TypeMappingInfo[] typeMappingInfos,
 JavaClass[] javaClasses,
 Map<Type,TypeMappingInfo> typeToTypeMappingInfo,
 Map<String,XmlBindings> xmlBindings,
 ClassLoader cLoader,
 String defaultTargetNamespace,
 boolean enableXmlAccessorFactory)

This constructor will process and apply the given XmlBindings as appropriate. Classes declared in the bindings will be amalgamated with any classes in the JavaModelInput. If xmlBindings is null or empty, AnnotationsProcessor will be used to process annotations as per usual.

Parameters:

xmlBindings - map of XmlBindings keyed on package name

Method Details

postInitialize

public void postInitialize()

This event is called when mappings generation is completed, and provides a chance to deference anything that is no longer needed (to reduce the memory footprint of this object).

hasMarshalCallbacks

public boolean hasMarshalCallbacks()

hasUnmarshalCallbacks

public boolean hasUnmarshalCallbacks()

generateProject

public CoreProject generateProject()
                            throws Exception

Throws:

Exception

generateSchema

public Collection<Schema> generateSchema()

generateSchemaFiles

public Map<String,SchemaTypeInfo> generateSchemaFiles(String schemaPath,
 Map<QName,Type> additionalGlobalElements)
                                               throws FileNotFoundException

Throws:

FileNotFoundException

generateSchemaFiles

public Map<String,SchemaTypeInfo> generateSchemaFiles(SchemaOutputResolver outputResolver,
 Map<QName,Type> additionalGlobalElements)

getUnmarshalCallbacks

public Map<String,UnmarshalCallback> getUnmarshalCallbacks()

getMarshalCallbacks

public Map<String,MarshalCallback> getMarshalCallbacks()

getMappingsGenerator

public MappingsGenerator getMappingsGenerator()

getAnnotationsProcessor

public AnnotationsProcessor getAnnotationsProcessor()

setTypeToTypeMappingInfo

public void setTypeToTypeMappingInfo(Map<Type,TypeMappingInfo> typesToTypeMapping)

getTypeToTypeMappingInfo

public Map<Type,TypeMappingInfo> getTypeToTypeMappingInfo()