Package com.google.auto.value.processor

Class AutoValueTemplateVars

  • class AutoValueTemplateVars
extends TemplateVars
    The variables to substitute into the autovalue.vm template.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) java.lang.String actualTypes
      The generic signature used by the generated subclass for its superclass reference.
      (package private) com.google.common.collect.ImmutableList<java.lang.String> annotations
      The full spelling of any annotation to add to this class, or an empty list if there are none.
      (package private) java.lang.String builderActualTypes
      The generic signature used by the generated builder subclass for its superclass reference.
      (package private) java.lang.String builderFormalTypes
      The formal generic signature of the AutoValue.Builder class.
      (package private) com.google.common.collect.ImmutableMap<java.lang.String,​BuilderSpec.PropertyGetter> builderGetters
      A map from property names to information about the associated property getter.
      (package private) java.lang.Boolean builderIsInterface
      True if the builder being implemented is an interface, false if it is an abstract class.
      (package private) com.google.common.collect.ImmutableMap<java.lang.String,​PropertyBuilderClassifier.PropertyBuilder> builderPropertyBuilders
      A map from property names to information about the associated property builder.
      (package private) com.google.common.collect.ImmutableSet<AutoValueOrOneOfProcessor.Property> builderRequiredProperties
      Properties that are required to be set.
      (package private) com.google.common.collect.ImmutableMultimap<java.lang.String,​BuilderSpec.PropertySetter> builderSetters
      A multimap from property names (like foo) to the corresponding setters.
      (package private) java.lang.String builderTypeName
      The name of the builder type as it should appear in source code, or empty if there is no builder type.
      (package private) java.util.Optional<SimpleMethod> buildMethod
      The builder's build method, often "build".
      (package private) java.lang.Boolean equals
      Whether to generate an equals(Object) method.
      (package private) java.lang.String equalsParameterType
      A string representing the parameter type declaration of the equals(Object) method, including any annotations.
      (package private) java.lang.String finalSubclass
      The simple name of the final generated subclass.
      (package private) java.lang.String formalTypes
      The formal generic signature of the class with the @AutoValue annotation and its generated subclass.
      (package private) java.lang.String generated
      The encoding of the Generated class.
      (package private) java.lang.String gwtCompatibleAnnotation
      The encoding of the @GwtCompatible annotation to add to this class, or an empty string if there is none.
      (package private) java.lang.Boolean hashCode
      Whether to generate a hashCode() method.
      (package private) java.lang.Boolean identifiers
      Whether to include identifiers in strings in the generated code.
      (package private) java.lang.Boolean isFinal
      True if the generated class should be final (there are no extensions that will generate subclasses)
      (package private) java.lang.String origClass
      The name of the class with the @AutoValue annotation, including containing classes but not including the package name.
      (package private) java.lang.String pkg
      The package of the class with the @AutoValue annotation and its generated subclass.
      (package private) com.google.common.collect.ImmutableSet<AutoValueOrOneOfProcessor.Property> props
      The properties defined by the parent class's abstract methods.
      (package private) java.lang.String serialVersionUID
      The text of the serialVersionUID constant, or empty if there is none.
      (package private) java.lang.String simpleClassName
      The simple name of the class with the @AutoValue annotation.
      (package private) java.lang.String subclass
      The simple name of the generated subclass.
      private static Template TEMPLATE  
      (package private) com.google.common.collect.ImmutableList<SimpleMethod> toBuilderMethods
      Any toBuilder() methods, that is methods that return the builder type.
      (package private) java.lang.Boolean toString
      Whether to generate a toString() method.
      (package private) javax.lang.model.util.Types types
      The type utilities returned by ProcessingEnvironment.getTypeUtils().
      (package private) java.lang.String wildcardTypes
      The generic signature in actualTypes where every variable has been replaced by a wildcard, for example <?, ?>.

    • Field Detail

      • props

        com.google.common.collect.ImmutableSet<AutoValueOrOneOfProcessor.Property> props
        The properties defined by the parent class's abstract methods. The elements of this set are in the same order as the original abstract method declarations in the AutoValue class.

      • equals

        java.lang.Boolean equals
        Whether to generate an equals(Object) method.

      • hashCode

        java.lang.Boolean hashCode
        Whether to generate a hashCode() method.

      • toString

        java.lang.Boolean toString
        Whether to generate a toString() method.

      • equalsParameterType

        java.lang.String equalsParameterType
        A string representing the parameter type declaration of the equals(Object) method, including any annotations. If equals is false, this field is ignored (but it must still be non-null).

      • identifiers

        java.lang.Boolean identifiers
        Whether to include identifiers in strings in the generated code. If false, exception messages will not mention properties by name, and toString() will include neither property names nor the name of the @AutoValue class.

      • types

        javax.lang.model.util.Types types
        The type utilities returned by ProcessingEnvironment.getTypeUtils().

      • generated

        java.lang.String generated
        The encoding of the Generated class. Empty if the class is not available.

      • gwtCompatibleAnnotation

        java.lang.String gwtCompatibleAnnotation
        The encoding of the @GwtCompatible annotation to add to this class, or an empty string if there is none. A non-empty value will look something like "@`com.google.common.annotations.GwtCompatible`(serializable = true)", where the `` represent the encoding used by TypeEncoder.

      • annotations

        com.google.common.collect.ImmutableList<java.lang.String> annotations
        The full spelling of any annotation to add to this class, or an empty list if there are none. A non-empty value might look something like "@com.google.common.annotations.GwtCompatible(serializable = true)".

      • serialVersionUID

        java.lang.String serialVersionUID
        The text of the serialVersionUID constant, or empty if there is none.

      • pkg

        java.lang.String pkg
        The package of the class with the @AutoValue annotation and its generated subclass.

      • origClass

        java.lang.String origClass
        The name of the class with the @AutoValue annotation, including containing classes but not including the package name.

      • simpleClassName

        java.lang.String simpleClassName
        The simple name of the class with the @AutoValue annotation.

      • subclass

        java.lang.String subclass
        The simple name of the generated subclass.

      • finalSubclass

        java.lang.String finalSubclass
        The simple name of the final generated subclass. For @AutoValue public static class Foo {} this should always be "AutoValue_Foo".

      • isFinal

        java.lang.Boolean isFinal
        True if the generated class should be final (there are no extensions that will generate subclasses)

      • formalTypes

        java.lang.String formalTypes
        The formal generic signature of the class with the @AutoValue annotation and its generated subclass. This is empty, or contains type variables with optional bounds, for example <K, V extends K>.

      • actualTypes

        java.lang.String actualTypes
        The generic signature used by the generated subclass for its superclass reference. This is empty, or contains only type variables with no bounds, for example <K, V>.

      • wildcardTypes

        java.lang.String wildcardTypes
        The generic signature in actualTypes where every variable has been replaced by a wildcard, for example <?, ?>.

      • builderTypeName

        java.lang.String builderTypeName
        The name of the builder type as it should appear in source code, or empty if there is no builder type. If class Address contains @AutoValue.Builder class Builder then this will typically be "Address.Builder".

      • builderFormalTypes

        java.lang.String builderFormalTypes
        The formal generic signature of the AutoValue.Builder class. This is empty, or contains type variables with optional bounds, for example <K, V extends K>.

      • builderActualTypes

        java.lang.String builderActualTypes
        The generic signature used by the generated builder subclass for its superclass reference. This is empty, or contains only type variables with no bounds, for example <K, V>.

      • builderIsInterface

        java.lang.Boolean builderIsInterface
        True if the builder being implemented is an interface, false if it is an abstract class.

      • buildMethod

        java.util.Optional<SimpleMethod> buildMethod
        The builder's build method, often "build".

      • builderSetters

        com.google.common.collect.ImmutableMultimap<java.lang.String,​BuilderSpec.PropertySetter> builderSetters
        A multimap from property names (like foo) to the corresponding setters. The same property may be set by more than one setter. For example, an ImmutableList might be set by setFoo(ImmutableList<String>) and setFoo(String[]).

      • builderPropertyBuilders

        com.google.common.collect.ImmutableMap<java.lang.String,​PropertyBuilderClassifier.PropertyBuilder> builderPropertyBuilders
        A map from property names to information about the associated property builder. A property called foo (defined by a method foo() or getFoo()) can have a property builder called fooBuilder(). The type of foo must be a type that has an associated builder following certain conventions. Guava immutable types such as ImmutableList follow those conventions, as do many @AutoValue types.

      • builderRequiredProperties

        com.google.common.collect.ImmutableSet<AutoValueOrOneOfProcessor.Property> builderRequiredProperties
        Properties that are required to be set. A property must be set explicitly except in the following cases:
        • it is @Nullable (in which case it defaults to null);
        • it is Optional (in which case it defaults to empty);
        • it has a property-builder method (in which case it defaults to empty).

      • builderGetters

        com.google.common.collect.ImmutableMap<java.lang.String,​BuilderSpec.PropertyGetter> builderGetters
        A map from property names to information about the associated property getter. A property called foo (defined by a method foo() or getFoo()) can have a property getter method with the same name (foo() or getFoo()) and either the same return type or an Optional (or OptionalInt, etc) wrapping it.

      • toBuilderMethods

        com.google.common.collect.ImmutableList<SimpleMethod> toBuilderMethods
        Any toBuilder() methods, that is methods that return the builder type.

      • TEMPLATE

        private static final Template TEMPLATE

    • Constructor Detail

      • AutoValueTemplateVars

        AutoValueTemplateVars()