JVMCICompilerFactory.java

/*
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package jdk.vm.ci.runtime;

import java.io.PrintStream;

/**
 * Factory for creating JVMCI compilers.
 */
public interface JVMCICompilerFactory {

    /**
     * Get the name of this compiler. The name is used by JVMCI to determine which factory to use.
     */
    String getCompilerName();

    /**
     * Notifies this object that it has been selected to {@linkplain #createCompiler(JVMCIRuntime)
     * create} a compiler and it should now perform any heavy weight initialization that it deferred
     * during construction.
     */
    default void onSelection() {
    }

    /**
     * Create a new instance of a {@link JVMCICompiler}.
     */
    JVMCICompiler createCompiler(JVMCIRuntime runtime);

    /**
     * Prints a description of the properties used to configure this compiler.
     *
     * @param out where to print the message
     */
    default void printProperties(PrintStream out) {
    }
}