org.gradle.api.internal.tasks.compile.processing.IncrementalProcessingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.api.internal.tasks.compile.processing;

import org.gradle.api.internal.tasks.compile.incremental.processing.AnnotationProcessorResult;

import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.JavaFileManager;
import java.util.Set;

/**
 * The strategy that updates the processing result according to the type and runtime behavior of a processor.
 */
abstract class IncrementalProcessingStrategy {
    protected final AnnotationProcessorResult result;

    IncrementalProcessingStrategy(AnnotationProcessorResult result) {
        this.result = result;
    }

    public abstract void recordProcessingInputs(Set supportedAnnotationTypes, Set annotations, RoundEnvironment roundEnv);

    public abstract void recordGeneratedType(CharSequence name, Element[] originatingElements);

    public final void recordGeneratedResource(JavaFileManager.Location location, CharSequence pkg, CharSequence relativeName, Element[] originatingElements) {
        result.setFullRebuildCause("an annotation processor generated a resource");
    }

    /**
     * We don't trigger a full recompile on resource reads, because we already trigger a full recompile when any
     * resource changes.
     */
    public final void recordAccessedResource(JavaFileManager.Location location, CharSequence pkg, CharSequence relativeName) {
    }
}