Package dagger.hilt.processor.internal

Class HiltCompilerOptions

  • public final class HiltCompilerOptions
extends java.lang.Object
    Hilt annotation processor options.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void checkWrongAndDeprecatedOptions​(javax.annotation.processing.ProcessingEnvironment env)  
      static GradleProjectType getGradleProjectType​(javax.annotation.processing.ProcessingEnvironment env)
      Returns project type or null if Hilt Gradle Plugin is not applied.
      static java.util.Set<java.lang.String> getProcessorOptions()  
      static boolean isAndroidSuperclassValidationDisabled​(javax.lang.model.element.TypeElement element, javax.annotation.processing.ProcessingEnvironment env)
      Returns true if the superclass validation is disabled for dagger.hilt.android.AndroidEntryPoint-annotated classes.
      static boolean isCrossCompilationRootValidationDisabled​(com.google.common.collect.ImmutableSet<javax.lang.model.element.TypeElement> rootElements, javax.annotation.processing.ProcessingEnvironment env)
      Returns true if cross-compilation root validation is disabled.
      static boolean isModuleInstallInCheckDisabled​(javax.annotation.processing.ProcessingEnvironment env)
      Returns true if the check for dagger.hilt.InstallIn is disabled.
      static boolean isSharedTestComponentsEnabled​(javax.annotation.processing.ProcessingEnvironment env)
      Returns true of unit tests should try to share generated components, rather than using separate generated components per Hilt test root.
      static boolean useAggregatingRootProcessor​(javax.annotation.processing.ProcessingEnvironment env)
      Returns true if the aggregating processor is enabled (default is true).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HiltCompilerOptions

        public HiltCompilerOptions()

    • Method Detail

      • isAndroidSuperclassValidationDisabled

        public static boolean isAndroidSuperclassValidationDisabled​(javax.lang.model.element.TypeElement element,
                                                            javax.annotation.processing.ProcessingEnvironment env)
        Returns true if the superclass validation is disabled for dagger.hilt.android.AndroidEntryPoint-annotated classes.

        This flag is for internal use only! The superclass validation checks that the super class is a generated Hilt_ class. This flag is disabled by the Hilt Gradle plugin to enable bytecode transformation to change the superclass.

      • isCrossCompilationRootValidationDisabled

        public static boolean isCrossCompilationRootValidationDisabled​(com.google.common.collect.ImmutableSet<javax.lang.model.element.TypeElement> rootElements,
                                                               javax.annotation.processing.ProcessingEnvironment env)
        Returns true if cross-compilation root validation is disabled.

        This flag should rarely be needed, but may be used for legacy/migration purposes if tests require the use of dagger.hilt.android.HiltAndroidApp rather than dagger.hilt.android.testing.HiltAndroidTest.

        Note that Hilt still does validation within a single compilation unit. In particular, a compilation unit that contains a HiltAndroidApp usage cannot have other HiltAndroidApp or HiltAndroidTest usages in the same compilation unit.

      • isModuleInstallInCheckDisabled

        public static boolean isModuleInstallInCheckDisabled​(javax.annotation.processing.ProcessingEnvironment env)
        Returns true if the check for dagger.hilt.InstallIn is disabled.

      • isSharedTestComponentsEnabled

        public static boolean isSharedTestComponentsEnabled​(javax.annotation.processing.ProcessingEnvironment env)
        Returns true of unit tests should try to share generated components, rather than using separate generated components per Hilt test root.

        Tests that provide their own test bindings (e.g. using dagger.hilt.android.testing.BindValue or a test Module) cannot use the shared component. In these cases, a component will be generated for the test.

      • useAggregatingRootProcessor

        public static boolean useAggregatingRootProcessor​(javax.annotation.processing.ProcessingEnvironment env)
        Returns true if the aggregating processor is enabled (default is true).

        Note:This is for internal use only!

      • getGradleProjectType

        public static GradleProjectType getGradleProjectType​(javax.annotation.processing.ProcessingEnvironment env)
        Returns project type or null if Hilt Gradle Plugin is not applied.

        Note:This is for internal use only!

      • checkWrongAndDeprecatedOptions

        public static void checkWrongAndDeprecatedOptions​(javax.annotation.processing.ProcessingEnvironment env)

      • getProcessorOptions

        public static java.util.Set<java.lang.String> getProcessorOptions()