modulecheck-api/modulecheck.api.context

Package-level declarations

Types

AndroidBasePackages

data class AndroidBasePackages(val delegate: SafeCache<SourceSetName, PackageName?>, val project: McProject) : ProjectContext.Element

AndroidDataBindingDeclarations

data class AndroidDataBindingDeclarations(val delegate: SafeCache<SourceSetName, LazySet<AndroidDataBindingDeclaredName>>, val project: McProject) : ProjectContext.Element

AndroidRDeclaredNames

data class AndroidRDeclaredNames(val delegate: SafeCache<SourceSetName, AndroidRDeclaredName?>, val project: McProject) : ProjectContext.Element

AndroidResourceDeclaredNames

data class AndroidResourceDeclaredNames(val delegate: SafeCache<SourceSetName, LazySet<AndroidResourceDeclaredName>>, val project: McProject) : ProjectContext.Element

AndroidResourceReferences

data class AndroidResourceReferences(val delegate: SafeCache<SourceSetName, LazySet<ReferenceName>>, val project: McProject) : ProjectContext.Element

AndroidStylesFiles

data class AndroidStylesFiles(val delegate: SafeCache<SourceSetName, Set<AndroidStylesFile>>, val project: McProject) : ProjectContext.Element

AndroidUnqualifiedResources

data class AndroidUnqualifiedResources(val delegate: SafeCache<SourceSetName, LazySet<UnqualifiedAndroidResource>>, val project: McProject) : ProjectContext.Element

the cache of UnqualifiedAndroidResource for this project

data class AnvilGraph(val project: McProject, val delegate: SafeCache<SourceSetName, Map<AnvilScopeName, AnvilScopedDeclarations>>) : ProjectContext.Element

Represents a graph of Anvil scopes and their associated declarations.

AnvilScopeContributions

data class AnvilScopeContributions(val delegate: SafeCache<SourceSetName, Map<AnvilScopeName, Set<QualifiedDeclaredName>>>, val project: McProject) : ProjectContext.Element

AnvilScopedDeclarations

data class AnvilScopedDeclarations(val scopeName: AnvilScopeName, val contributions: MutableSet<QualifiedDeclaredName>, val merges: MutableSet<QualifiedDeclaredName>)

Represents a set of Anvil scope declarations including both contributions and merges.

AnvilScopeDependencies

data class AnvilScopeDependencies(val delegate: SafeCache<SourceSetName, List<ProjectDependency>>, val project: McProject) : ProjectContext.Element

AnvilScopeMerges

data class AnvilScopeMerges(val delegate: SafeCache<SourceSetName, Map<AnvilScopeName, Set<QualifiedDeclaredName>>>, val project: McProject) : ProjectContext.Element

ClasspathDependencies

data class ClasspathDependencies(val delegate: SafeCache<SourceSetName, List<TransitiveProjectDependency>>, val project: McProject) : ProjectContext.Element

class Declarations(val delegate: SafeCache<Declarations.DeclarationsKey, LazySet<DeclaredName>>, val project: McProject) : ProjectContext.Element

DependencySources

data class DependencySources(val delegate: SafeCache<DependencySources.SourceKey, DependencySources.SourceResult>, val project: McProject) : ProjectContext.Element

data class Depths(val delegate: SafeCache<SourceSetName, ProjectDepth>, val project: McProject) : ProjectContext.Element

DownstreamProjects

data class DownstreamProjects(val delegate: Set<DownstreamDependency>) : Set<DownstreamDependency> , ProjectContext.Element

GeneratedDeclarations

class GeneratedDeclarations(val project: McProject) : ProjectContext.Element

Cache of all Generated declarations created by this project, where each Generated lists its sources.

data class Imports(val delegate: SafeCache<SourceSetName, LazySet<ReferenceName>>, val project: McProject) : ProjectContext.Element

InheritedDependencyWithSource

data class InheritedDependencyWithSource(val projectDependency: ProjectDependency, val source: ProjectDependency?)

data class JvmFiles(val fileFactoryCache: SafeCache<SourceSetName, JvmFileProvider>, val project: McProject) : ProjectContext.Element

Represents a collection of JVM files for a project.

data class JvmSourceFiles(val delegate: SafeCache<SourceSetName, Set<File>>, val project: McProject) : ProjectContext.Element

All JVM source files for a specific source set in a project.

KaptDependencies

data class KaptDependencies(val delegate: SafeCache<ConfigurationName, Set<ConfiguredDependency>>, val project: McProject) : ProjectContext.Element

data class LayoutFiles(val delegate: SafeCache<SourceSetName, Set<XmlFile.LayoutFile>>, val project: McProject) : ProjectContext.Element

data class ManifestFiles(val delegate: SafeCache<SourceSetName, XmlFile.ManifestFile?>, val project: McProject) : ProjectContext.Element

data class MustBeApi(val delegate: Set<InheritedDependencyWithSource>) : Set<InheritedDependencyWithSource> , ProjectContext.Element

data class ProjectDepth(val dependentProject: McProject, val dependentPath: ProjectPath.StringProjectPath, val depth: Int, val children: List<ProjectDepth>, val sourceSetName: SourceSetName) : Comparable<ProjectDepth>

PublicDependencies

data class PublicDependencies(val delegate: Set<ProjectDependency>) : Set<ProjectDependency> , ProjectContext.Element

data class References(val delegate: SafeCache<SourceSetName, LazySet<ReferenceName>>, val project: McProject) : ProjectContext.Element

ResolvedDeclaredNames

class ResolvedDeclaredNames(val delegate: SafeCache<ResolvedDeclaredNames.NameInSourceSet, ResolvedDeclaredNames.SourceResult>, val project: McProject) : ProjectContext.Element

data class ResSourceFiles(val delegate: SafeCache<SourceSetName, Set<File>>, val project: McProject) : ProjectContext.Element

SourceSetDependencies

data class SourceSetDependencies(val delegate: SafeCache<SourceSetName, List<TransitiveProjectDependency>>, val project: McProject) : ProjectContext.Element

Functions

androidBasePackages

suspend fun ProjectContext.androidBasePackages(): AndroidBasePackages

androidBasePackagesForSourceSetName

suspend fun ProjectContext.androidBasePackagesForSourceSetName(sourceSetName: SourceSetName): PackageName?

androidDataBindingDeclarations

suspend fun ProjectContext.androidDataBindingDeclarations(): AndroidDataBindingDeclarations

androidDataBindingDeclarationsForSourceSetName

suspend fun ProjectContext.androidDataBindingDeclarationsForSourceSetName(sourceSetName: SourceSetName): LazySet<AndroidDataBindingDeclaredName>

androidRDeclaredNameForSourceSetName

suspend fun ProjectContext.androidRDeclaredNameForSourceSetName(sourceSetName: SourceSetName): AndroidRDeclaredName?

androidRDeclaredNames

suspend fun ProjectContext.androidRDeclaredNames(): AndroidRDeclaredNames

androidResourceDeclaredNames

suspend fun ProjectContext.androidResourceDeclaredNames(): AndroidResourceDeclaredNames

androidResourceDeclaredNamesForSourceSetName

suspend fun ProjectContext.androidResourceDeclaredNamesForSourceSetName(sourceSetName: SourceSetName): LazySet<AndroidResourceDeclaredName>

androidResourceReferencesForSourceSetName

suspend fun ProjectContext.androidResourceReferencesForSourceSetName(sourceSetName: SourceSetName): LazySet<ReferenceName>

androidStylesFiles

suspend fun ProjectContext.androidStylesFiles(): AndroidStylesFiles

androidStylesFilesForSourceSetName

suspend fun ProjectContext.androidStylesFilesForSourceSetName(sourceSetName: SourceSetName): Set<AndroidStylesFile>

androidUnqualifiedResources

suspend fun ProjectContext.androidUnqualifiedResources(): AndroidUnqualifiedResources

androidUnqualifiedResourcesForSourceSetName

suspend fun ProjectContext.androidUnqualifiedResourcesForSourceSetName(sourceSetName: SourceSetName): LazySet<UnqualifiedAndroidResource>

suspend fun ProjectContext.anvilGraph(): AnvilGraph

Extension function to retrieve AnvilGraph from the ProjectContext.

anvilScopeContributions

suspend fun ProjectContext.anvilScopeContributions(): AnvilScopeContributions

anvilScopeContributionsForSourceSetName

suspend fun ProjectContext.anvilScopeContributionsForSourceSetName(sourceSetName: SourceSetName): Map<AnvilScopeName, Set<QualifiedDeclaredName>>

anvilScopeDependencies

suspend fun ProjectContext.anvilScopeDependencies(): AnvilScopeDependencies

anvilScopeDependenciesForSourceSetName

suspend fun ProjectContext.anvilScopeDependenciesForSourceSetName(sourceSetName: SourceSetName): List<ProjectDependency>

anvilScopeMerges

suspend fun ProjectContext.anvilScopeMerges(): AnvilScopeMerges

anvilScopeMergesForSourceSetName

suspend fun ProjectContext.anvilScopeMergesForSourceSetName(sourceSetName: SourceSetName): Map<AnvilScopeName, Set<QualifiedDeclaredName>>

classpathDependencies

suspend fun ProjectContext.classpathDependencies(): ClasspathDependencies

suspend fun ProjectContext.declarations(): Declarations

suspend fun ProjectDependency.declarations(projectCache: ProjectCache, packageNameOrNull: PackageName? = null): LazySet<DeclaredName>

dependencySources

suspend fun ProjectContext.dependencySources(): DependencySources

suspend fun ProjectContext.dependents(): DownstreamProjects

All projects which are downstream of the receiver project, including those which only inherit via another dependency's api configuration without declaring the dependency directly.

depthForSourceSetName

suspend fun McProject.depthForSourceSetName(sourceSetName: SourceSetName): ProjectDepth

suspend fun McProject.depths(): Depths

generatedDeclarations

suspend fun ProjectContext.generatedDeclarations(): GeneratedDeclarations

shorthand for project.get(GeneratedDeclarations)

suspend fun ProjectContext.generatedDeclarations(sourceSetName: SourceSetName): LazySet<Generated>

suspend fun ProjectContext.generatedDeclarations(sourceSetName: SourceSetName, sourceDeclarations: LazySet<DeclaredName>): LazySet<Generated>

generationIsUsedDownstream

private suspend fun McProject.generationIsUsedDownstream(generatedRefs: LazySet<Generated>, referencesSourceSetName: SourceSetName): Boolean

suspend fun ProjectContext.imports(): Imports

importsForSourceSetName

suspend fun ProjectContext.importsForSourceSetName(sourceSetName: SourceSetName): LazySet<ReferenceName>

suspend fun ProjectContext.jvmFiles(): JvmFiles

Retrieves JvmFiles from the ProjectContext.

jvmFilesForSourceSetName

suspend fun ProjectContext.jvmFilesForSourceSetName(sourceSetName: SourceSetName): Flow<JvmFile>

Retrieves a flow of JVM files corresponding to the provided source set name from the ProjectContext.

suspend fun ProjectContext.jvmSourceFiles(): JvmSourceFiles

jvmSourcesForSourceSetName

suspend fun ProjectContext.jvmSourcesForSourceSetName(sourceSetName: SourceSetName): Set<File>

kaptDependencies

suspend fun ProjectContext.kaptDependencies(): KaptDependencies

kaptDependenciesForConfig

suspend fun ProjectContext.kaptDependenciesForConfig(configurationName: ConfigurationName): Set<ConfiguredDependency>

suspend fun ProjectContext.layoutFiles(): LayoutFiles

layoutFilesForSourceSetName

suspend fun ProjectContext.layoutFilesForSourceSetName(sourceSetName: SourceSetName): Set<XmlFile.LayoutFile>

manifestFileForSourceSetName

suspend fun ProjectContext.manifestFileForSourceSetName(sourceSetName: SourceSetName): XmlFile.ManifestFile?

suspend fun ProjectContext.manifestFiles(): ManifestFiles

inline suspend fun <T : ConfiguredDependency> T.maybeAsApi(dependentProject: McProject): T

suspend fun ProjectContext.mustBeApi(): MustBeApi

suspend fun McProject.mustBeApiIn(dependentProject: McProject, sourceSetName: SourceSetName, isTestFixtures: Boolean): Boolean

private suspend fun McProject.mustBeApiIn(dependentProject: McProject, referencesFromDependencies: Set<ReferenceName>, sourceSetName: SourceSetName, isTestFixtures: Boolean, directMainDependencies: List<McProject>): Boolean

publicDependencies

suspend fun ProjectContext.publicDependencies(): PublicDependencies

suspend fun ProjectContext.references(): References

referencesForSourceSetName

suspend fun ProjectContext.referencesForSourceSetName(sourceSetName: SourceSetName): LazySet<ReferenceName>

referencesFromDependencies

private suspend fun McProject.referencesFromDependencies(sourceSetName: SourceSetName): Set<ReferenceName>

requireSourceOf

suspend fun McProject.requireSourceOf(dependencyProject: McProject, sourceSetName: SourceSetName, isTestFixture: Boolean): ProjectDependency

resolvedDeclaredNames

suspend fun ProjectContext.resolvedDeclaredNames(): ResolvedDeclaredNames

resourceFilesForSourceSetName

suspend fun ProjectContext.resourceFilesForSourceSetName(sourceSetName: SourceSetName): Set<File>

suspend fun ProjectContext.resSourceFiles(): ResSourceFiles

sourceSetDependencies

suspend fun ProjectContext.sourceSetDependencies(): SourceSetDependencies

suspend fun McProject.uses(dependency: ConfiguredDependency): Boolean

usesCodeGenDependency

private suspend fun <T : ConfiguredDependency, MightHaveCodeGeneratorBinding> McProject.usesCodeGenDependency(dependency: T): Boolean

usesRuntimeDependency

private suspend fun McProject.usesRuntimeDependency(dependency: ProjectDependency.RuntimeProjectDependency): Boolean