com.google.auto.value.processor.ExtensionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-impl-jetty12 Show documentation
There is a newer version: 2.0.31
/*
 * Copyright 2015 Google LLC
 *
 * 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 com.google.auto.value.processor;

import static com.google.auto.value.processor.ClassNames.COPY_ANNOTATIONS_NAME;

import com.google.auto.value.extension.AutoValueExtension;
import com.google.auto.value.extension.AutoValueExtension.BuilderContext;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Maps;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.type.TypeMirror;

class ExtensionContext implements AutoValueExtension.Context {

  private final AutoValueProcessor autoValueProcessor;
  private final ProcessingEnvironment processingEnvironment;
  private final TypeElement autoValueClass;
  private final ImmutableMap properties;
  private final ImmutableMap propertyTypes;
  private final ImmutableSet abstractMethods;
  private final ImmutableSet builderAbstractMethods;
  private Optional builderContext = Optional.empty();

  ExtensionContext(
      AutoValueProcessor autoValueProcessor,
      ProcessingEnvironment processingEnvironment,
      TypeElement autoValueClass,
      ImmutableMap properties,
      ImmutableMap propertyMethodsAndTypes,
      ImmutableSet abstractMethods,
      ImmutableSet builderAbstractMethods) {
    this.autoValueProcessor = autoValueProcessor;
    this.processingEnvironment = processingEnvironment;
    this.autoValueClass = autoValueClass;
    this.properties = properties;
    this.propertyTypes =
        ImmutableMap.copyOf(Maps.transformValues(properties, propertyMethodsAndTypes::get));
    this.abstractMethods = abstractMethods;
    this.builderAbstractMethods = builderAbstractMethods;
  }

  void setBuilderContext(BuilderContext builderContext) {
    this.builderContext = Optional.of(builderContext);
  }

  @Override
  public ProcessingEnvironment processingEnvironment() {
    return processingEnvironment;
  }

  @Override
  public String packageName() {
    return TypeSimplifier.packageNameOf(autoValueClass);
  }

  @Override
  public TypeElement autoValueClass() {
    return autoValueClass;
  }

  @Override
  public String finalAutoValueClassName() {
    return AutoValueProcessor.generatedSubclassName(autoValueClass, 0);
  }

  @Override
  public Map properties() {
    return properties;
  }

  @Override
  public Map propertyTypes() {
    return Maps.transformValues(propertyTypes, AnnotatedTypeMirror::getType);
  }

  @Override
  public Set abstractMethods() {
    return abstractMethods;
  }

  @Override
  public Set builderAbstractMethods() {
    return builderAbstractMethods;
  }

  @Override
  public List classAnnotationsToCopy(TypeElement classToCopyFrom) {
    // Only copy annotations from a class if it has @AutoValue.CopyAnnotations.
    if (!AutoValueishProcessor.hasAnnotationMirror(classToCopyFrom, COPY_ANNOTATIONS_NAME)) {
      return ImmutableList.of();
    }

    ImmutableSet excludedAnnotations =
        ImmutableSet.builder()
            .addAll(AutoValueishProcessor.getExcludedAnnotationClassNames(classToCopyFrom))
            .addAll(AutoValueishProcessor.getAnnotationsMarkedWithInherited(classToCopyFrom))
            //
            // Kotlin classes have an intrinsic @Metadata annotation generated
            // onto them by kotlinc. This annotation is specific to the annotated
            // class and should not be implicitly copied. Doing so can mislead
            // static analysis or metaprogramming tooling that reads the data
            // contained in these annotations.
            //
            // It may be surprising to see AutoValue classes written in Kotlin
            // when they could be written as Kotlin data classes, but this can
            // come up in cases where consumers rely on AutoValue features or
            // extensions that are not available in data classes.
            //
            // See: https://github.com/google/auto/issues/1087
            //
            .add(ClassNames.KOTLIN_METADATA_NAME)
            .build();

    return autoValueProcessor.annotationsToCopy(
        autoValueClass, classToCopyFrom, excludedAnnotations);
  }

  @Override
  public List methodAnnotationsToCopy(ExecutableElement method) {
    return autoValueProcessor.propertyMethodAnnotations(autoValueClass, method);
  }

  @Override
  public Optional builder() {
    return builderContext;
  }
}