001/*
002 * Copyright (C) 2022 - 2023, 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 (0.0.1-M6)
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>This is usually the default mode.
036   */
037  COMPILATION_AND_ANNOTATION_PROCESSING,
038
039  /**
040   * Run compilation, but skip any annotation processing that may run.
041   *
042   * <p>This corresponds to providing {@code -proc:none} in the OpenJDK Javac implementation.
043   */
044  COMPILATION_ONLY,
045
046  /**
047   * Skip compilation, but run any annotation processing that may be enabled.
048   *
049   * <p>This corresponds to providing {@code -proc:only} in the OpenJDK Javac implementation.
050   */
051  ANNOTATION_PROCESSING_ONLY,
052}