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 Details

    • getModel

      Model getModel()
      This outline is for this model.
    • getCodeModel

      JCodeModel getCodeModel()
      Short for getModel().codeModel.
    • getField

      Gets the object that wraps the generated field for a given CPropertyInfo.
    • 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 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

      JClassContainer getContainer(CClassInfoParent parent, Aspect aspect)
    • resolve

      JType resolve(CTypeRef ref, Aspect aspect)
      Resolves a type reference to the actual (possibly generated) type. Short for resolve(ref.getType(),aspect).
    • addRuntime

      JClass addRuntime(Class clazz)
      Copies the specified class into the user's package and returns a reference to it.