Module com.sun.tools.xjc

Package com.sun.tools.xjc.outline

Interface Outline

All Known Implementing Classes:

BeanGenerator

public interface Outline

Root of the outline. Captures which code is generated for which model component.

This object also provides access to various utilities, such as error reporting etc, for the convenience of code that builds the outline.

Author:

Kohsuke Kawaguchi

Method Summary

Modifier and Type	Method	Description
com.sun.codemodel.JClass	addRuntime(Class clazz)	Copies the specified class into the user's package and returns a reference to it.
Iterable<? extends PackageOutline>	getAllPackageContexts()	Gets all package-wise contexts at once.
Collection<? extends ClassOutline>	getClasses()	Returns all the ClassOutlines known to this object.
CodeModelClassFactory	getClassFactory()	Gets a reference to new CodeModelClassFactory(getErrorHandler()).
ClassOutline	getClazz(CClassInfo clazz)	Obtains per-class context information.
com.sun.codemodel.JCodeModel	getCodeModel()	Short for getModel().codeModel.
com.sun.codemodel.JClassContainer	getContainer(CClassInfoParent parent, Aspect aspect)
ElementOutline	getElement(CElementInfo ei)	If the CElementInfo generates a class, returns such a class.
EnumOutline	getEnum(CEnumLeafInfo eli)
Collection<EnumOutline>	getEnums()	Gets all the EnumOutlines.
ErrorReceiver	getErrorReceiver()	Any error during the back-end proccessing should be sent to this object.
FieldOutline	getField(CPropertyInfo fu)	Gets the object that wraps the generated field for a given CPropertyInfo.
Model	getModel()	This outline is for this model.
PackageOutline	getPackageContext(com.sun.codemodel.JPackage _Package)	Gets per-package context information.
com.sun.codemodel.JType	resolve(CTypeRef ref, Aspect aspect)	Resolves a type reference to the actual (possibly generated) type.

Method Detail

getModel

Model getModel()

This outline is for this model.

getCodeModel

com.sun.codemodel.JCodeModel getCodeModel()

Short for getModel().codeModel.

getField

FieldOutline getField(CPropertyInfo fu)

Gets the object that wraps the generated field for a given CPropertyInfo.

getPackageContext

PackageOutline getPackageContext(com.sun.codemodel.JPackage _Package)

Gets per-package context information. This method works for every visible package (those packages which are supposed to be used by client applications.)

Returns:

If this grammar doesn't produce anything in the specified package, return null.

getClasses

Collection<? extends ClassOutline> getClasses()

Returns all the ClassOutlines known to this object.

getClazz

ClassOutline getClazz(CClassInfo clazz)

Obtains per-class context information.

getElement

ElementOutline getElement(CElementInfo ei)

If the CElementInfo generates a class, returns such a class. Otherwise return null.

getEnum

EnumOutline getEnum(CEnumLeafInfo eli)

getEnums

Collection<EnumOutline> getEnums()

Gets all the EnumOutlines.

getAllPackageContexts

Iterable<? extends PackageOutline> getAllPackageContexts()

Gets all package-wise contexts at once.

getClassFactory

CodeModelClassFactory getClassFactory()

Gets a reference to new CodeModelClassFactory(getErrorHandler()).

getErrorReceiver

ErrorReceiver getErrorReceiver()

Any error during the back-end proccessing should be sent to this object.

getContainer

com.sun.codemodel.JClassContainer getContainer(CClassInfoParent parent,
                                               Aspect aspect)

resolve

com.sun.codemodel.JType resolve(CTypeRef ref,
                                Aspect aspect)

Resolves a type reference to the actual (possibly generated) type. Short for resolve(ref.getType(),aspect).

addRuntime

com.sun.codemodel.JClass addRuntime(Class clazz)

Copies the specified class into the user's package and returns a reference to it.