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

Class IjFolder

java.lang.Object

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

All Implemented Interfaces:

Comparable<IjFolder>

Direct Known Subclasses:

ExcludeFolder, InclusiveFolder

public abstract class IjFolder
extends Object
implements Comparable<IjFolder>

A path which contains a set of sources we wish to present to IntelliJ.

Method Summary

Modifier and Type	Method and Description
boolean	canMergeWith(IjFolder other)
static com.google.common.collect.ImmutableSortedSet<Path>	combineInputs(IjFolder first, IjFolder second)
int	compareTo(IjFolder other)
IjFolder	createCopyWith(Path path) Create a copy of this folder using the specified path.
boolean	equals(Object other)
protected abstract IJFolderFactory	getFactory()
abstract String	getIjName()
com.google.common.collect.ImmutableSortedSet<Path>	getInputs()
Path	getPath()
boolean	getWantsPackagePrefix() Used to make IntelliJ ignore the package name->folder structure convention and assume the given package prefix.
int	hashCode()
boolean	isResourceFolder()
IjFolder	merge(IjFolder otherFolder)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getIjName

public abstract String getIjName()

Returns:

name IntelliJ would use to refer to this type of folder.

getPath

public Path getPath()

Returns:

path that this folder represents relative to the project root.

getInputs

public com.google.common.collect.ImmutableSortedSet<Path> getInputs()

Returns:

set of input files corresponding to this folder.

getFactory

protected abstract IJFolderFactory getFactory()

Returns:

a IJFolderFactory to create new instances of the folder class.

createCopyWith

public IjFolder createCopyWith(Path path)

Create a copy of this folder using the specified path.

Returns:

a copy of this object with the new path

isResourceFolder

public boolean isResourceFolder()

Returns:

true if it should be marked as a java-resource or java-test-resource folder, false otherwise.

getWantsPackagePrefix

public boolean getWantsPackagePrefix()

Used to make IntelliJ ignore the package name->folder structure convention and assume the given package prefix. An example of a scenario this makes possible to achieve is having java/src/Foo.java declare the package "org.bar" (instead of having the path to the file be java/org/bar/Foo.java). The main effect of this is the elimination of IntelliJ warnings about incorrect package prefixes and having it use the correct package when creating new files.

Returns:

whether to generate package prefix for this folder.

canMergeWith

public boolean canMergeWith(IjFolder other)

merge

public IjFolder merge(IjFolder otherFolder)

compareTo

public int compareTo(IjFolder other)

Specified by:

compareTo in interface Comparable<IjFolder>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

combineInputs

public static com.google.common.collect.ImmutableSortedSet<Path> combineInputs(IjFolder first,
                                                                               IjFolder second)