Top Description Methods

com.sun.tools.xjc.outline

public Interface Outline

Known Direct Implementers: com.sun.tools.xjc.generator.bean.BeanGenerator
Imports: java.util.Collection, com.sun.codemodel.JClass, .JClassContainer, .JCodeModel, .JPackage, .JType, com.sun.tools.xjc.ErrorReceiver, com.sun.tools.xjc.model.CClassInfo, .CClassInfoParent, .CElementInfo, .CEnumLeafInfo, .CPropertyInfo, .CTypeRef, .Model, com.sun.tools.xjc.util.CodeModelClassFactory

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

Method Detail

addRuntime	back to summary
public JClass addRuntime(Class<?> clazz) Copies the specified class into the user's package and returns a reference to it.

getAllPackageContexts	back to summary
public Iterable<? extends PackageOutline> getAllPackageContexts() Gets all package-wise contexts at once.

getClasses	back to summary
public Collection<? extends ClassOutline> getClasses() Returns all the `ClassOutline`s known to this object.

getClassFactory	back to summary
public CodeModelClassFactory getClassFactory() Gets a reference to `new CodeModelClassFactory(getErrorHandler())`.

getClazz	back to summary
public ClassOutline getClazz(CClassInfo clazz) Obtains per-class context information.

getCodeModel	back to summary
public JCodeModel getCodeModel() Short for `getModel().codeModel`.

getContainer	back to summary
public JClassContainer getContainer(CClassInfoParent parent, Aspect aspect)

getElement	back to summary
public ElementOutline getElement(CElementInfo ei) If the `CElementInfo` generates a class, returns such a class. Otherwise return null.

getEnum	back to summary
public EnumOutline getEnum(CEnumLeafInfo eli)

getEnums	back to summary
public Collection<EnumOutline> getEnums() Gets all the `EnumOutline`s.

getErrorReceiver	back to summary
public ErrorReceiver getErrorReceiver() Any error during the back-end proccessing should be sent to this object.

getField	back to summary
public FieldOutline getField(CPropertyInfo fu) Gets the object that wraps the generated field for a given `CPropertyInfo`.

getModel	back to summary
public Model getModel() This outline is for this model.

getPackageContext

back to summary

public PackageOutline getPackageContext(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:PackageOutline: If this grammar doesn't produce anything in the specified package, return null.

resolve	back to summary
public JType resolve(CTypeRef ref, Aspect aspect) Resolves a type reference to the actual (possibly generated) type. Short for `resolve(ref.getType(),aspect)`.