com.facebook.buck.features.project.intellij

Class BaseIjModuleRule<T extends BuildRuleArg>

java.lang.Object

com.facebook.buck.features.project.intellij.BaseIjModuleRule<T>

All Implemented Interfaces:

IjModuleRule<T>

Direct Known Subclasses:

AndroidModuleRule, CxxLibraryModuleRule, CxxTestModuleRule, GroovyLibraryModuleRule, GroovyTestModuleRule, JavaBinaryModuleRule, JavaLibraryModuleRule, JavaTestModuleRule, KotlinLibraryModuleRule, KotlinTestModuleRule, PythonLibraryModuleRule, PythonTestModuleRule, ScalaLibraryModuleRule, ScalaTestModuleRule

public abstract class BaseIjModuleRule<T extends BuildRuleArg>
extends Object
implements IjModuleRule<T>

Base class for IntelliJ module rules

Field Summary

Fields

Modifier and Type	Field and Description
protected IjModuleFactoryResolver	moduleFactoryResolver
protected IjProjectConfig	projectConfig
protected ProjectFilesystem	projectFilesystem

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseIjModuleRule(ProjectFilesystem projectFilesystem, IjModuleFactoryResolver moduleFactoryResolver, IjProjectConfig projectConfig)

Method Summary

Modifier and Type	Method and Description
protected void	addDepsAndSources(TargetNode<T> targetNode, boolean wantsPackagePrefix, ModuleBuildContext context)
protected void	addDepsAndSources(TargetNode<T> targetNode, boolean wantsPackagePrefix, ModuleBuildContext context, com.google.common.collect.ImmutableSet<Path> resourcePaths)
protected void	addDepsAndTestSources(TargetNode<T> targetNode, boolean wantsPackagePrefix, ModuleBuildContext context)
protected void	addDepsAndTestSources(TargetNode<T> targetNode, boolean wantsPackagePrefix, ModuleBuildContext context, com.google.common.collect.ImmutableSet<Path> resourcePaths)
protected void	addResourceFolders(IjResourceFolderType ijResourceFolderType, com.google.common.collect.ImmutableCollection<Path> resourcePaths, Path resourcesRoot, ModuleBuildContext context)
protected void	addResourceFolders(ResourceFolderFactory factory, com.google.common.collect.ImmutableMultimap<Path,Path> foldersToInputsIndex, Path resourcesRoot, ModuleBuildContext context)
protected void	addSourceFolders(IJFolderFactory factory, com.google.common.collect.ImmutableMultimap<Path,Path> foldersToInputsIndex, boolean wantsPackagePrefix, ModuleBuildContext context) Add the set of input paths to the IjModule.Builder as source folders.
void	applyDuringAggregation(AggregationContext context, TargetNode<T> targetNode)
protected com.google.common.collect.ImmutableSet<Path>	getResourcePaths(Collection<SourcePath> resources)
protected com.google.common.collect.ImmutableSet<Path>	getResourcePaths(Collection<SourcePath> resources, Path resourcesRoot)
protected com.google.common.collect.ImmutableMultimap<Path,Path>	getResourcesRootsToResources(JavaPackageFinder packageFinder, com.google.common.collect.ImmutableSet<Path> resourcePaths)
protected static com.google.common.collect.ImmutableMultimap<Path,Path>	getSourceFoldersToInputsIndex(com.google.common.collect.ImmutableCollection<Path> paths) Calculate the set of directories containing inputs to the target.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.features.project.intellij.model.IjModuleRule

apply, detectModuleType, getDescriptionClass

Field Detail

projectFilesystem

protected final ProjectFilesystem projectFilesystem

moduleFactoryResolver

protected final IjModuleFactoryResolver moduleFactoryResolver

projectConfig

protected final IjProjectConfig projectConfig

Constructor Detail

BaseIjModuleRule

protected BaseIjModuleRule(ProjectFilesystem projectFilesystem,
                           IjModuleFactoryResolver moduleFactoryResolver,
                           IjProjectConfig projectConfig)

Method Detail

getSourceFoldersToInputsIndex

protected static com.google.common.collect.ImmutableMultimap<Path,Path> getSourceFoldersToInputsIndex(com.google.common.collect.ImmutableCollection<Path> paths)

Calculate the set of directories containing inputs to the target.

Parameters:

paths - inputs to a given target.

Returns:

index of path to set of inputs in that path

addSourceFolders

protected void addSourceFolders(IJFolderFactory factory,
                                com.google.common.collect.ImmutableMultimap<Path,Path> foldersToInputsIndex,
                                boolean wantsPackagePrefix,
                                ModuleBuildContext context)

Add the set of input paths to the IjModule.Builder as source folders.

Parameters:

foldersToInputsIndex - mapping of source folders to their inputs.

wantsPackagePrefix - whether folders should be annotated with a package prefix. This only makes sense when the source folder is Java source code.

context - the module to add the folders to.

addResourceFolders

protected void addResourceFolders(ResourceFolderFactory factory,
                                  com.google.common.collect.ImmutableMultimap<Path,Path> foldersToInputsIndex,
                                  Path resourcesRoot,
                                  ModuleBuildContext context)

addDepsAndSources

protected void addDepsAndSources(TargetNode<T> targetNode,
                                 boolean wantsPackagePrefix,
                                 ModuleBuildContext context,
                                 com.google.common.collect.ImmutableSet<Path> resourcePaths)

addDepsAndSources

protected void addDepsAndSources(TargetNode<T> targetNode,
                                 boolean wantsPackagePrefix,
                                 ModuleBuildContext context)

addDepsAndTestSources

protected void addDepsAndTestSources(TargetNode<T> targetNode,
                                     boolean wantsPackagePrefix,
                                     ModuleBuildContext context,
                                     com.google.common.collect.ImmutableSet<Path> resourcePaths)

addDepsAndTestSources

protected void addDepsAndTestSources(TargetNode<T> targetNode,
                                     boolean wantsPackagePrefix,
                                     ModuleBuildContext context)

getResourcePaths

protected com.google.common.collect.ImmutableSet<Path> getResourcePaths(Collection<SourcePath> resources)

getResourcePaths

protected com.google.common.collect.ImmutableSet<Path> getResourcePaths(Collection<SourcePath> resources,
                                                                        Path resourcesRoot)

getResourcesRootsToResources

protected com.google.common.collect.ImmutableMultimap<Path,Path> getResourcesRootsToResources(JavaPackageFinder packageFinder,
                                                                                              com.google.common.collect.ImmutableSet<Path> resourcePaths)

addResourceFolders

protected void addResourceFolders(IjResourceFolderType ijResourceFolderType,
                                  com.google.common.collect.ImmutableCollection<Path> resourcePaths,
                                  Path resourcesRoot,
                                  ModuleBuildContext context)

applyDuringAggregation

public void applyDuringAggregation(AggregationContext context,
                                   TargetNode<T> targetNode)

Specified by:

applyDuringAggregation in interface IjModuleRule<T extends BuildRuleArg>