SourceDirectories

@Incubating interface SourceDirectories

Known direct subclasses
SourceDirectories.Flat

Represents all the source folders for a source type in the variant.

SourceDirectories.Layered

Represent a collection of directories that have overlay properties to each other.


Defines all common behaviors to sources access in AGP.

Adding directories is always added to the "Variant" overlay and will therefore carry the highest possible priority among all directories for the source type.

Summary

Nested types

SourceDirectories.Flat

Represents all the source folders for a source type in the variant.

SourceDirectories.Layered

Represent a collection of directories that have overlay properties to each other.

Public functions

Unit
<TASK : Task?> addGeneratedSourceDirectory(
    taskProvider: TaskProvider<TASK?>?,
    wiredWith: ((TASK) -> DirectoryProperty)?
)

Add the output of a custom task to the list of source directories.

Unit

Add a source directory with sources already present to the variant.

Inherited functions

From class Named

Public functions

addGeneratedSourceDirectory

fun <TASK : Task?> addGeneratedSourceDirectory(
    taskProvider: TaskProvider<TASK?>?,
    wiredWith: ((TASK) -> DirectoryProperty)?
): Unit

Add the output of a custom task to the list of source directories.

The Directory is the output of a Task TASK that has been registered using the Gradle's Task manager.

The Directory is added last to the variant's list of source directories. In case there is merging for the source type, the Directory will have the highest priority.

Parameters
taskProvider: TaskProvider<TASK?>?

the TaskProvider returned by Gradle's Task manager when registering the Task of type TASK.

wiredWith: ((TASK) -> DirectoryProperty)?

the method reference returning the TASK task's output to use as a source directory. The generated source directory location is automatically determined by the Android Gradle Plugin

addStaticSourceDirectory

fun addStaticSourceDirectory(srcDir: String?): Unit

Add a source directory with sources already present to the variant.

The directory will be added last in the list of source folders for the variant. In case there is merging for the source type, srcDir will be the folder with the highest priority.

Do not use addStaticSourceDirectory to add sources that are generated by a task, instead use addGeneratedSourceDirectory

Parameters
srcDir: String?

the source directory path, that will be resolved using the Directory.dir API relative to the Gradle project directory.