com.facebook.buck.features.project.intellij.model

Class IjModule

java.lang.Object

com.facebook.buck.features.project.intellij.model.IjModule

All Implemented Interfaces:

IjProjectElement

public abstract class IjModule
extends Object
implements IjProjectElement

Represents a single IntelliJ module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IjModule.Builder

Constructor Summary

Constructors

Constructor and Description
IjModule()

Method Summary

Modifier and Type	Method and Description
void	addAsDependency(DependencyType dependencyType, IjDependencyListBuilder dependencyListBuilder)
static IjModule.Builder	builder()
protected void	checkDependencyConsistency()
boolean	equals(Object another)
abstract Optional<IjModuleAndroidFacet>	getAndroidFacet()
abstract Optional<Path>	getCompilerOutputPath()
abstract com.google.common.collect.ImmutableMap<BuildTarget,DependencyType>	getDependencies()
abstract com.google.common.collect.ImmutableSet<IjLibrary>	getExtraLibraryDependencies()
abstract com.google.common.collect.ImmutableSet<Path>	getExtraModuleDependencies()
abstract com.google.common.collect.ImmutableList<IjFolder>	getFolders()
abstract com.google.common.collect.ImmutableList<IjFolder>	getGeneratedSourceCodeFolders()
abstract Optional<String>	getLanguageLevel()
abstract Optional<Path>	getMetaInfDirectory()
abstract Path	getModuleBasePath()
abstract IjModuleType	getModuleType()
String	getName()
abstract com.google.common.collect.ImmutableSet<BuildTarget>	getNonSourceBuildTargets()
abstract com.google.common.collect.ImmutableSet<BuildTarget>	getTargets()
abstract Map<BuildTarget,List<IjFolder>>	getTargetsToGeneratedSourcesMap()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

IjModule

public IjModule()

Method Detail

getName

@Value.Derived
public String getName()

Specified by:

getName in interface IjProjectElement

Returns:

unique string identifying the element. This will be used by modules to refer to it.

getTargets

public abstract com.google.common.collect.ImmutableSet<BuildTarget> getTargets()

Specified by:

getTargets in interface IjProjectElement

Returns:

set of targets this element corresponds to in the IntelliJ project.

getNonSourceBuildTargets

public abstract com.google.common.collect.ImmutableSet<BuildTarget> getNonSourceBuildTargets()

getTargetsToGeneratedSourcesMap

public abstract Map<BuildTarget,List<IjFolder>> getTargetsToGeneratedSourcesMap()

getModuleBasePath

public abstract Path getModuleBasePath()

Returns:

path to the top-most directory the module is responsible for.

getFolders

public abstract com.google.common.collect.ImmutableList<IjFolder> getFolders()

Returns:

paths to various directories the module is responsible for.

getDependencies

public abstract com.google.common.collect.ImmutableMap<BuildTarget,DependencyType> getDependencies()

Returns:

map of BuildTargets the module depends on and information on whether it's a test-only dependency or not.

getAndroidFacet

public abstract Optional<IjModuleAndroidFacet> getAndroidFacet()

getExtraLibraryDependencies

public abstract com.google.common.collect.ImmutableSet<IjLibrary> getExtraLibraryDependencies()

Returns:

a set of IjLibrary that the module requires to index all symbols correctly.

getExtraModuleDependencies

public abstract com.google.common.collect.ImmutableSet<Path> getExtraModuleDependencies()

Returns:

a set of module paths that the module requires to index correctly.

getGeneratedSourceCodeFolders

public abstract com.google.common.collect.ImmutableList<IjFolder> getGeneratedSourceCodeFolders()

Returns:

Folders which contain the generated source code.

getLanguageLevel

public abstract Optional<String> getLanguageLevel()

getModuleType

public abstract IjModuleType getModuleType()

getMetaInfDirectory

public abstract Optional<Path> getMetaInfDirectory()

getCompilerOutputPath

public abstract Optional<Path> getCompilerOutputPath()

checkDependencyConsistency

@Value.Check
protected void checkDependencyConsistency()

addAsDependency

public void addAsDependency(DependencyType dependencyType,
                            IjDependencyListBuilder dependencyListBuilder)

Specified by:

addAsDependency in interface IjProjectElement

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object another)

Overrides:

equals in class Object

builder

public static IjModule.Builder builder()