Package org.robolectric.annotation.processing

Class RobolectricProcessor

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.robolectric.annotation.processing.RobolectricProcessor
All Implemented Interfaces:
javax.annotation.processing.Processor
@SupportedOptions({"org.robolectric.annotation.processing.shadowPackage","org.robolectric.annotation.processing.shouldInstrumentPackage"})
@SupportedAnnotationTypes("org.robolectric.annotation.*")
public class RobolectricProcessor
extends javax.annotation.processing.AbstractProcessor
Annotation processor entry point for Robolectric annotations.

  • Field Summary

    Fields inherited from class javax.annotation.processing.AbstractProcessor

    processingEnv

  • Constructor Summary

    Constructors 
    Constructor Description
    RobolectricProcessor()
    Default constructor.
    RobolectricProcessor​(Map<String,​String> options)
    Constructor to use for testing passing options in.

  • Method Summary

    Modifier and Type Method Description
    protected String getSdksFile​(Map<String,​String> options, String sdksFileParam)
    Extendable to support Bazel environments, where the sdks file is generated as a build artifact.
    javax.lang.model.SourceVersion getSupportedSourceVersion()  
    void init​(javax.annotation.processing.ProcessingEnvironment environment)  
    boolean process​(Set<? extends javax.lang.model.element.TypeElement> annotations, javax.annotation.processing.RoundEnvironment roundEnv)  

    Methods inherited from class javax.annotation.processing.AbstractProcessor

    getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RobolectricProcessor

      public RobolectricProcessor()
      Default constructor.

    • RobolectricProcessor

      public RobolectricProcessor​(Map<String,​String> options)
      Constructor to use for testing passing options in. Only necessary until compile-testing supports passing options in.
      Parameters:
      options - simulated options that would ordinarily be passed in the ProcessingEnvironment.

  • Method Details

    • init

      public void init​(javax.annotation.processing.ProcessingEnvironment environment)
      Specified by:
      init in interface javax.annotation.processing.Processor
      Overrides:
      init in class javax.annotation.processing.AbstractProcessor

    • process

      public boolean process​(Set<? extends javax.lang.model.element.TypeElement> annotations, javax.annotation.processing.RoundEnvironment roundEnv)
      Specified by:
      process in interface javax.annotation.processing.Processor
      Specified by:
      process in class javax.annotation.processing.AbstractProcessor

    • getSdksFile

      protected String getSdksFile​(Map<String,​String> options, String sdksFileParam)
      Extendable to support Bazel environments, where the sdks file is generated as a build artifact.

    • getSupportedSourceVersion

      public javax.lang.model.SourceVersion getSupportedSourceVersion()
      Specified by:
      getSupportedSourceVersion in interface javax.annotation.processing.Processor
      Overrides:
      getSupportedSourceVersion in class javax.annotation.processing.AbstractProcessor