001/*
002 * Copyright (C) 2022 - 2024, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.compilers;
017
018import org.apiguardian.api.API;
019import org.apiguardian.api.API.Status;
020
021/**
022 * An enum representing the various types of compilation mode that a compiler can run under.
023 *
024 * <p>This corresponds to the {@code -proc} flag in the OpenJDK Javac implementation.
025 *
026 * @author Ashley Scopes
027 * @since 0.0.1
028 */
029@API(since = "0.0.1", status = Status.STABLE)
030public enum CompilationMode {
031
032  /**
033   * Run compilation and run the annotation processors, if configured.
034   *
035   * <p>Prior to Java 21, this is the default if no {@code -proc} flag is provided to the compiler.
036   *
037   * <p>From Java 21 and onwards, this is equivalent to passing {@code -proc:full} to the compiler.
038   */
039  COMPILATION_AND_ANNOTATION_PROCESSING,
040
041  /**
042   * Run compilation, but skip any annotation processing that may run.
043   *
044   * <p>This corresponds to providing {@code -proc:none} in the OpenJDK Javac implementation.
045   */
046  COMPILATION_ONLY,
047
048  /**
049   * Skip compilation, but run any annotation processing that may be enabled.
050   *
051   * <p>This corresponds to providing {@code -proc:only} in the OpenJDK Javac implementation.
052   */
053  ANNOTATION_PROCESSING_ONLY,
054}