com.facebook.buck.core.sourcepath.resolver.impl

Class AbstractSourcePathResolver

java.lang.Object

com.facebook.buck.core.sourcepath.resolver.impl.AbstractSourcePathResolver

All Implemented Interfaces:

SourcePathResolver

Direct Known Subclasses:

DefaultSourcePathResolver, IjProjectSourcePathResolver

public abstract class AbstractSourcePathResolver
extends Object
implements SourcePathResolver

Abstract implementation of SourcePathResolver.

Most of the SourcePathResolverAdapter interface can be implemented in terms of just a few functions ( the main requirement is resolving BuildTargetSourcePaths).

Existing code may expect to resolve each SourcePath to only one Path. In such cases, SourcePathResolverAdapter is used to convert the resolver to return only one Path per SourcePath.

Constructor Summary

Constructors

Constructor and Description
AbstractSourcePathResolver()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<Path,Path>	createRelativeMap(Path basePath, Iterable<SourcePath> sourcePaths) Creates a map where given source paths are resolved relatively to the given base path and stored (as keys) with their absolute paths (as values).
com.google.common.collect.ImmutableCollection<Path>	filterInputsToCompareToOutput(Iterable<? extends SourcePath> sources) Takes an Iterable of SourcePath objects and filters those that represent Paths.
com.google.common.collect.ImmutableSortedSet<Path>	getAbsolutePath(SourcePath sourcePath)
com.google.common.collect.ImmutableSortedSet<Path>	getAllAbsolutePaths(Collection<? extends SourcePath> sourcePaths)
protected abstract ProjectFilesystem	getBuildTargetSourcePathFilesystem(BuildTargetSourcePath sourcePath)
ProjectFilesystem	getFilesystem(SourcePath sourcePath)
com.google.common.collect.ImmutableSortedSet<Path>	getIdeallyRelativePath(SourcePath sourcePath)
<T> com.google.common.collect.ImmutableMap<T,com.google.common.collect.ImmutableSortedSet<Path>>	getMappedPaths(Map<T,SourcePath> sourcePathMap)
com.google.common.collect.ImmutableSortedSet<Path>	getRelativePath(ProjectFilesystem projectFilesystem, SourcePath sourcePath)
com.google.common.collect.ImmutableSortedSet<Path>	getRelativePath(SourcePath sourcePath)
abstract String	getSourcePathName(BuildTarget target, SourcePath sourcePath)
com.google.common.collect.ImmutableMap<String,SourcePath>	getSourcePathNames(BuildTarget target, String parameter, Iterable<SourcePath> sourcePaths) Resolved the logical names for a group of SourcePath objects into a map, throwing an error on duplicates.
<T> com.google.common.collect.ImmutableMap<String,T>	getSourcePathNames(BuildTarget target, String parameter, Iterable<T> objects, java.util.function.Predicate<T> filter, java.util.function.Function<T,SourcePath> objectSourcePathFunction) Resolves the logical names for a group of objects that have a SourcePath into a map, throwing an error on duplicates.
protected abstract com.google.common.collect.ImmutableSortedSet<SourcePath>	resolveDefaultBuildTargetSourcePath(DefaultBuildTargetSourcePath targetSourcePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSourcePathResolver

public AbstractSourcePathResolver()

Method Detail

resolveDefaultBuildTargetSourcePath

protected abstract com.google.common.collect.ImmutableSortedSet<SourcePath> resolveDefaultBuildTargetSourcePath(DefaultBuildTargetSourcePath targetSourcePath)

getSourcePathName

public abstract String getSourcePathName(BuildTarget target,
                                         SourcePath sourcePath)

Specified by:

getSourcePathName in interface SourcePathResolver

getBuildTargetSourcePathFilesystem

protected abstract ProjectFilesystem getBuildTargetSourcePathFilesystem(BuildTargetSourcePath sourcePath)

getMappedPaths

public <T> com.google.common.collect.ImmutableMap<T,com.google.common.collect.ImmutableSortedSet<Path>> getMappedPaths(Map<T,SourcePath> sourcePathMap)

Specified by:

getMappedPaths in interface SourcePathResolver

getFilesystem

public ProjectFilesystem getFilesystem(SourcePath sourcePath)

Specified by:

getFilesystem in interface SourcePathResolver

Returns:

the ProjectFilesystem associated with sourcePath.

getAbsolutePath

public com.google.common.collect.ImmutableSortedSet<Path> getAbsolutePath(SourcePath sourcePath)

Specified by:

getAbsolutePath in interface SourcePathResolver

Returns:

the Path instances for this sourcePath, resolved using its associated ProjectFilesystem.

getAllAbsolutePaths

public com.google.common.collect.ImmutableSortedSet<Path> getAllAbsolutePaths(Collection<? extends SourcePath> sourcePaths)

Specified by:

getAllAbsolutePaths in interface SourcePathResolver

getRelativePath

public com.google.common.collect.ImmutableSortedSet<Path> getRelativePath(SourcePath sourcePath)

Specified by:

getRelativePath in interface SourcePathResolver

Returns:

The Path instances the sourcePath refers to, relative to its owning ProjectFilesystem.

getIdeallyRelativePath

public com.google.common.collect.ImmutableSortedSet<Path> getIdeallyRelativePath(SourcePath sourcePath)

Specified by:

getIdeallyRelativePath in interface SourcePathResolver

Returns:

The Path instances the sourcePath refers to, ideally relative to its owning ProjectFilesystem. Absolute path may get returned however!

We should make sure that getPathPrivateImpl(com.facebook.buck.core.sourcepath.SourcePath) always returns a relative path after which we should simply call getRelativePath(com.facebook.buck.core.sourcepath.SourcePath). Until then we still need this nonsense.

getSourcePathNames

public com.google.common.collect.ImmutableMap<String,SourcePath> getSourcePathNames(BuildTarget target,
                                                                                    String parameter,
                                                                                    Iterable<SourcePath> sourcePaths)

Resolved the logical names for a group of SourcePath objects into a map, throwing an error on duplicates.

Specified by:

getSourcePathNames in interface SourcePathResolver

getSourcePathNames

public <T> com.google.common.collect.ImmutableMap<String,T> getSourcePathNames(BuildTarget target,
                                                                               String parameter,
                                                                               Iterable<T> objects,
                                                                               java.util.function.Predicate<T> filter,
                                                                               java.util.function.Function<T,SourcePath> objectSourcePathFunction)

Resolves the logical names for a group of objects that have a SourcePath into a map, throwing an error on duplicates.

Specified by:

getSourcePathNames in interface SourcePathResolver

filterInputsToCompareToOutput

public com.google.common.collect.ImmutableCollection<Path> filterInputsToCompareToOutput(Iterable<? extends SourcePath> sources)

Takes an Iterable of SourcePath objects and filters those that represent Paths.

Specified by:

filterInputsToCompareToOutput in interface SourcePathResolver

getRelativePath

public com.google.common.collect.ImmutableSortedSet<Path> getRelativePath(ProjectFilesystem projectFilesystem,
                                                                          SourcePath sourcePath)

Specified by:

getRelativePath in interface SourcePathResolver

Returns:

Path instances to the given SourcePath that is relative to the given ProjectFilesystem

createRelativeMap

public com.google.common.collect.ImmutableMap<Path,Path> createRelativeMap(Path basePath,
                                                                           Iterable<SourcePath> sourcePaths)

Description copied from interface: SourcePathResolver

Creates a map where given source paths are resolved relatively to the given base path and stored (as keys) with their absolute paths (as values).

Specified by:

createRelativeMap in interface SourcePathResolver