Interface IClassBodyEvaluator

    • Field Detail

      • DEFAULT_CLASS_NAME

        static final java.lang.String DEFAULT_CLASS_NAME
        Default name for the generated class.
        See Also:
        Constant Field Values
    • Method Detail

      • setParentClassLoader

        void setParentClassLoader​(@Nullable
                                  java.lang.ClassLoader parentClassLoader)
        The "parent class loader" is used to load referenced classes. Useful values are:
        System.getSystemClassLoader() The running JVM's class path
        Thread.currentThread().getContextClassLoader() or null The class loader effective for the invoking thread
        ClassLoaders.BOOTCLASSPATH_CLASS_LOADER The running JVM's boot class path

        The parent class loader defaults to the current thread's context class loader.

      • setDebuggingInformation

        void setDebuggingInformation​(boolean debugSource,
                                     boolean debugLines,
                                     boolean debugVars)
        Determines what kind of debugging information is included in the generates classes. The default is typically "-g:none".
      • setWarningHandler

        void setWarningHandler​(@Nullable
                               WarningHandler warningHandler)
        By default, warnings are discarded, but an application my install a custom WarningHandler.
        Parameters:
        warningHandler - null to indicate that no warnings be issued
      • setDefaultImports

        void setDefaultImports​(java.lang.String... defaultImports)
        "Default imports" add to the system import "java.lang", i.e. the evaluator may refer to classes imported by default imports without having to explicitly declare IMPORT statements.

        Notice that JDK 5 "static imports" are also supported, as shown here:

             sc.setDefaultImports(
                 "java.util.Map",                          // Single type import
                 "java.io.*",                              // Type-import-on-demand
                 "static java.util.Collections.EMPTY_MAP", // Single static import
                 "static java.util.Collections.*",         // Static-import-on-demand
             );
      • getDefaultImports

        java.lang.String[] getDefaultImports()
        Returns:
        The default imports that were previously configured with setDefaultImports(String...)
      • setClassName

        void setClassName​(java.lang.String className)
        Sets the name of the generated class. Defaults to DEFAULT_CLASS_NAME. In most cases, there is no need to set this name, because the generated class is loaded into its own ClassLoader where its name cannot collide with classes generated by other evaluators.

        One reason to use this function is to have a class name in a non-default package, which can be relevant when types and members with DEFAULT accessibility are accessed.

      • setExtendedClass

        void setExtendedClass​(@Nullable
                              java.lang.Class<?> extendedClass)
        Sets a particular superclass that the generated class will extend. If extendedClass is null, the generated class will extend Object.

        The usual reason to set a base class for an evaluator is that the generated class can directly access the superclass's (non-private) members.

      • setImplementedInterfaces

        void setImplementedInterfaces​(java.lang.Class<?>[] implementedInterfaces)
        Sets a particular set of interfaces that the generated class will implement.
      • setImplementedTypes

        @Deprecated
        void setImplementedTypes​(java.lang.Class<?>[] implementedInterfaces)
        Deprecated.
      • getClazz

        java.lang.Class<?> getClazz()
        Returns:
        The generated Class
        Throws:
        java.lang.IllegalStateException - This IClassBodyEvaluator is not yet cooked
      • createInstance

        java.lang.Object createInstance​(java.io.Reader reader)
                                 throws CompileException,
                                        java.io.IOException
        Scans, parses and compiles a class body from the tokens delivered by the the given Reader, then creates and returns an instance of that class.
        Parameters:
        reader - Source of class body tokens
        Returns:
        An object that extends the extendedType and implements the given implementedTypes
        Throws:
        CompileException
        java.io.IOException