All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hazelcast.shaded.org.codehaus.commons.compiler.ISimpleCompiler Maven / Gradle / Ivy

There is a newer version: 5.5.0
Show newest version

/*
 * Janino - An embedded Java[TM] compiler
 *
 * Copyright (c) 2001-2010 Arno Unkrig. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *       following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
 *       products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.hazelcast.shaded.org.codehaus.commons.compiler;

import java.io.Reader;

import com.hazelcast.shaded.org.codehaus.commons.compiler.lang.ClassLoaders;
import com.hazelcast.shaded.org.codehaus.commons.nullanalysis.Nullable;

/**
 * A simplified Java compiler that can compile only a single compilation unit. (A "compilation unit" is the document
 * stored in a ".java" file.)
 * 

* Opposed to a normal ".java" file, you can declare multiple public classes here. *

*

* To set up an {@link ISimpleCompiler} object, proceed as follows: *

*
    *
  1. Create an {@link ISimpleCompiler}-implementing object
  2. *
  3. Optionally set an alternate parent class loader through {@link #setParentClassLoader(ClassLoader)}.
  4. *
  5. * Call any of the {@link ICookable#cook(String, Reader)} methods to scan, parse, compile and load the compilation * unit into the JVM. *
  6. *
  7. * Call {@link #getClassLoader()} to obtain a {@link ClassLoader} that you can use to access the compiled classes. *
  8. *
*

Comptibility notice:

*

* The methods {@code setPermissions(Permissions permissions)} and {@code void setNoPermissions()} were removed in * version 3.1.1 (2020-03-09) and replaced by the {@link Sandbox}. *

*/ public interface ISimpleCompiler extends ICookable { /** * The "parent class loader" is used to load referenced classes. Useful values are: * * * * * * * * * *
{@code System.getSystemClassLoader()}The running JVM's class path
{@code Thread.currentThread().getContextClassLoader()} or {@code null}The class loader effective for the invoking thread
{@link ClassLoaders#BOOTCLASSPATH_CLASS_LOADER}The running JVM's boot class path
*

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

*/ void setParentClassLoader(@Nullable ClassLoader parentClassLoader); /** * Determines what kind of debugging information is included in the generates classes. The default is typically * "{@code -g:none}". */ void setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars); /** * Installs an {@link ErrorHandler} which is invoked during compilation on each error. (By default, the compilation * throws a {@link CompileException} on the first error and terminates.) *

* If the given {@link ErrorHandler} throws a {@link CompileException}, then the compilation terminates and * the exception is propagated. *

*

* If the given {@link ErrorHandler} does not throw a {@link CompileException} but completes normally, then the * compilation may or may not continue, depending on the error. Iff the compilation * completes normally but errors were reported, then it will throw a {@link CompileException} indicating the * number of errors. *

*

* In other words: The {@link ErrorHandler} may throw a {@link CompileException} or not, but the compilation will * definitely throw a {@link CompileException} if one or more compile errors have occurred. *

* * @param compileErrorHandler {@code null} to restore the default behavior (throwing a {@link CompileException}) */ void setCompileErrorHandler(@Nullable ErrorHandler compileErrorHandler); /** * By default, warnings are discarded, but an application my install a custom {@link WarningHandler} which is * invoked for each warning. If, for some untypical reason, that warning handler wants to terminate the compilation * as quickly as possible, then it would throw a {@link CompileException}. * * @param warningHandler {@code null} to indicate that no warnings be issued */ void setWarningHandler(@Nullable WarningHandler warningHandler); /** * Returns a {@link ClassLoader} object through which the previously compiled classes can be accessed. This {@link * ClassLoader} can be used for subsequent {@link ISimpleCompiler}s in order to compile compilation units that use * types (e.g. declare derived types) declared in the previous one. *

* This method must only be called after exactly one of the {@link #cook(String, java.io.Reader)} methods was * called. *

*/ ClassLoader getClassLoader(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy