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

/*
 * Copyright (C) 2014 Google, Inc.
 *
 * 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 com.google.auto.value.processor.escapevelocity.Template;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;

/**
 * The variables to substitute into the autoannotation.vm template.
 *
 * @author [email protected] (Éamonn McManus)
 */
@SuppressWarnings("unused")  // the fields in this class are only read via reflection
class AutoAnnotationTemplateVars extends TemplateVars {
  /**
   * The members of the annotation being implemented.
   */
  Map members;

  /**
   * The parameters in the {@code @AutoAnnotation} method, which are also the constructor parameters
   * in the generated class.
   */
  Map params;

  /**
   * The fully-qualified names of the classes to be imported in the generated class.
   */
  SortedSet imports;

  /**
   * The spelling of the javax.annotation.Generated class: Generated or javax.annotation.Generated.
   */
  String generated;

  /** The spelling of the java.util.Arrays class: Arrays or java.util.Arrays. */
  String arrays;

  /**
   * The package of the class containing the {@code @AutoAnnotation} annotation, which is also the
   * package where the annotation implementation will be generated.
   */
  String pkg;

  /**
   * The simple name of the generated class, like {@code AutoAnnotation_Foo_bar}.
   */
  String className;

  /**
   * The name of the annotation interface as it can be referenced in the generated code.
   */
  String annotationName;

  /**
   * The fully-qualified name of the annotation interface.
   */
  String annotationFullName;

  /**
   * The wrapper types (like {@code Integer.class}) that are referenced in collection parameters
   * (like {@code List}).
   */
  Set> wrapperTypesUsedInCollections;

  /**
   * True if this annotation is marked {@code @GwtCompatible}. That means that we can't use
   * {@code clone()} to make a copy of an array.
   */
  Boolean gwtCompatible;

  /**
   * The names of members that are defaulted (not mentioned) in this {@code @AutoAnnotation},
   * and whose hash codes are invariable.
   */
  Set invariableHashes;

  /**
   * The sum of the hash code contributions from the members in {@link #invariableHashes}.
   */
  Integer invariableHashSum;

  private static final Template TEMPLATE = parsedTemplateForResource("autoannotation.vm");

  @Override
  Template parsedTemplate() {
    return TEMPLATE;
  }
}