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 Detail

      • getModel

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

        JCodeModel getCodeModel()
        Short for getModel().codeModel.
      • 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

        java.util.Collection<? extends ClassOutline> getClasses()
        Returns all the ClassOutlines known to this object.
      • getAllPackageContexts

        java.lang.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.
      • 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​(java.lang.Class clazz)
        Copies the specified class into the user's package and returns a reference to it.