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