com.facebook.buck.jvm.java

Class DefaultJavaPackageFinder

java.lang.Object

com.facebook.buck.jvm.java.DefaultJavaPackageFinder

All Implemented Interfaces:

JavaPackageFinder

public class DefaultJavaPackageFinder
extends Object
implements JavaPackageFinder

Constructor Summary

Constructors

Constructor and Description
DefaultJavaPackageFinder(ProjectFilesystem projectFilesystem, com.google.common.collect.ImmutableSortedSet<String> pathsFromRoot, com.google.common.collect.ImmutableSet<String> pathElements)

Method Summary

Modifier and Type	Method and Description
static DefaultJavaPackageFinder	createDefaultJavaPackageFinder(ProjectFilesystem projectFilesystem, Iterable<String> pathPatterns)
String	findJavaPackage(BuildTarget buildTarget)
String	findJavaPackage(Path pathRelativeToProjectRoot)
Path	findJavaPackageFolder(Path pathRelativeToProjectRoot) Given the relative path to a file under the project root, return the Java package with which the file is associated.
static String	findJavaPackageWithPackageFolder(Path packageFolder)
com.google.common.collect.ImmutableSet<String>	getPathElements()
com.google.common.collect.ImmutableSortedSet<String>	getPathsFromRoot()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJavaPackageFinder

public DefaultJavaPackageFinder(ProjectFilesystem projectFilesystem,
                                com.google.common.collect.ImmutableSortedSet<String> pathsFromRoot,
                                com.google.common.collect.ImmutableSet<String> pathElements)

Method Detail

findJavaPackageFolder

public Path findJavaPackageFolder(Path pathRelativeToProjectRoot)

Description copied from interface: JavaPackageFinder

Given the relative path to a file under the project root, return the Java package with which the file is associated. For .java files, this is generally obvious, as they contain an explicit "package" statement. For other files, such as resources, other heuristics must be used.

Specified by:

findJavaPackageFolder in interface JavaPackageFinder

Parameters:

pathRelativeToProjectRoot - may be a path to either a file or a directory. If a directory, then it must end in a slash.

Returns:

a path that always ends with a slash, or the empty string, indicating the root directory.

getPathsFromRoot

public com.google.common.collect.ImmutableSortedSet<String> getPathsFromRoot()

getPathElements

public com.google.common.collect.ImmutableSet<String> getPathElements()

createDefaultJavaPackageFinder

public static DefaultJavaPackageFinder createDefaultJavaPackageFinder(ProjectFilesystem projectFilesystem,
                                                                      Iterable<String> pathPatterns)

Parameters:

pathPatterns - elements that start with a slash must be prefix patterns; all other elements indicate individual directory names (and therefore cannot contain slashes).

findJavaPackage

public String findJavaPackage(Path pathRelativeToProjectRoot)

Specified by:

findJavaPackage in interface JavaPackageFinder

findJavaPackage

public String findJavaPackage(BuildTarget buildTarget)

Specified by:

findJavaPackage in interface JavaPackageFinder

findJavaPackageWithPackageFolder

public static String findJavaPackageWithPackageFolder(Path packageFolder)