-
- All Implemented Interfaces:
-
com.mobwith.imgmodule.module.AppliesOptions,com.mobwith.imgmodule.module.RegistersComponents
public abstract class AppImageModule extends LibraryImageModule implements AppliesOptions
Defines a set of dependencies and options to use when initializing ImageModule within an application.
There can be at most one AppImageModule in an application. Only Applications can include a AppImageModule. Libraries must use LibraryImageModule.
Classes that extend AppImageModule must be annotated with to be processed correctly.
Classes that extend AppImageModule can optionally be annotated with to optionally exclude one or more and/or ImageModule classes.
Once an application has migrated itself and all libraries it depends on to use ImageModule annotation processor, AppImageModule implementations should override and return
{@code false}.
-
-
Method Summary
Modifier and Type Method Description booleanisManifestParsingEnabled()Returns {@code true}if ImageModule should check the AndroidManifest for ImageModules.voidapplyOptions(@NonNull() Context context, @NonNull() ImageBuilder builder)Lazily apply options to a ImageBuilder immediately before the ImageModulesingleton is created. -
Methods inherited from class com.mobwith.imgmodule.module.LibraryImageModule
registerComponents -
Methods inherited from class com.mobwith.imgmodule.module.RegistersComponents
registerComponents -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
isManifestParsingEnabled
boolean isManifestParsingEnabled()
Returns
{@code true}if ImageModule should check the AndroidManifest for ImageModules.Implementations should return
{@code false}after they and their dependencies have migratedto ImageModule annotation processor.Returns
{@code true}by default.
-
applyOptions
void applyOptions(@NonNull() Context context, @NonNull() ImageBuilder builder)
Lazily apply options to a ImageBuilder immediately before the ImageModulesingleton is created.
This method will be called once and only once per implementation.
- Parameters:
context- An Application Context.builder- The ImageBuilder that will be used to create ImageModule.
-
-
-
-