Overrides com.google.auto.value.extension.AutoValueExtension.applicable.

Doc from com.google.auto.value.extension.AutoValueExtension.applicable.

Determines whether this Extension applies to the given context. If an Extension returns false for a given class, it will not be called again during the processing of that class. An Extension can return true and still choose not to generate any code for the class, by returning null from generateClass. That is often a more flexible approach.

Parameters

context:AutoValueExtension.Context

The Context of the code generation for this class.

Annotations

@Override

Overrides com.google.auto.value.extension.AutoValueExtension.consumeMethods.

Doc from com.google.auto.value.extension.AutoValueExtension.consumeMethods.

Returns a possible empty set of abstract methods that this Extension intends to implement. This will prevent AutoValue from generating an implementation, in cases where it would have, and it will also avoid warnings about abstract methods that AutoValue doesn't expect. The default set returned by this method is empty.

Each returned method must be one of the abstract methods in Context#abstractMethods().

For example, Android's Parcelable interface includes a method void writeToParcel(Parcel, int). Normally AutoValue would not know what to do with that abstract method. But an AutoValueExtension that understands Parcelable can provide a useful implementation and return the writeToParcel method here. That will prevent a warning about the method from AutoValue.

Parameters

context:AutoValueExtension.Context

the Context of the code generation for this class.

Annotations

@Override

Implements abstract com.google.auto.value.extension.AutoValueExtension.generateClass.

Doc from com.google.auto.value.extension.AutoValueExtension.generateClass.

Returns the generated source code of the class named className to extend classToExtend, or null if this extension does not generate a class in the hierarchy. If there is a generated class, it should be final if isFinal is true; otherwise it should be abstract. The returned string should be a complete Java class definition of the class className in the package context.packageName().

The returned string will typically look like this:

package <package>;
...
<finalOrAbstract> class <className> extends <classToExtend> {
  // Constructor
  <className>(<constructorParameters>) {
    super(<constructorParameterNames>);
    ...
  }
  ...
}

Here, <package> is Context#packageName(); <finalOrAbstract> is the keyword final if isFinal is true or abstract otherwise; and <className> and <classToExtend> are the values of this method's parameters of the same name. The <constructorParameters> and <constructorParameterNames> are typically derived from Context#propertyTypes().

Parameters

context:AutoValueExtension.Context

The Context of the code generation for this class.

className:String

The simple name of the resulting class. The returned code will be written to a file named accordingly.

classToExtend:String

The simple name of the direct parent of the generated class. This could be the AutoValue generated class, or a class generated as the result of another Extension.

isFinal:boolean

True if this class is the last class in the chain, meaning it should be marked as final. Otherwise it should be marked as abstract.

Returns:String

The source code of the generated class, or null if this extension does not generate a class in the hierarchy.

Annotations

@Override

Overrides com.google.auto.value.extension.AutoValueExtension.incrementalType.

Doc from com.google.auto.value.extension.AutoValueExtension.incrementalType.

Determines the incremental type of this Extension.

The ProcessingEnvironment can be used, among other things, to obtain the processor options, using ProcessingEnvironment#getOptions().

The actual incremental type of the AutoValue processor as a whole will be the loosest incremental types of the Extensions present in the annotation processor path. The default returned value is IncrementalExtensionType#UNKNOWN, which will disable incremental annotation processing entirely.

Annotations

@Override