com.facebook.buck.core.sourcepath

Class ExplicitBuildTargetSourcePath

java.lang.Object

com.facebook.buck.core.sourcepath.ExplicitBuildTargetSourcePath

All Implemented Interfaces:

BuildTargetSourcePath, SourcePath, Comparable<SourcePath>

public abstract class ExplicitBuildTargetSourcePath
extends Object
implements BuildTargetSourcePath

A BuildTargetSourcePath which resolves to a specific (possibly non-default) output of the BuildRule referred to by its target.

Constructor Summary

Constructors

Constructor and Description
ExplicitBuildTargetSourcePath()

Method Summary

Modifier and Type	Method and Description
int	compareTo(SourcePath other)
boolean	equals(Object other)
abstract Optional<com.google.common.hash.HashCode>	getPrecomputedHash() In rare cases, a BuildTargetSourcePath may know a hash of its content on disk before it even creates its output.
abstract Path	getResolvedPath()
abstract BuildTargetWithOutputs	getTargetWithOutputs()
int	hashCode()
static ExplicitBuildTargetSourcePath	of(BuildTarget target, Path resolvedPath) Construct a new immutable ExplicitBuildTargetSourcePath instance.
static ExplicitBuildTargetSourcePath	of(BuildTargetWithOutputs target, Path resolvedPath) Construct a new immutable ExplicitBuildTargetSourcePath instance.
static ExplicitBuildTargetSourcePath	of(BuildTargetWithOutputs targetWithOutputs, Path resolvedPath, Optional<? extends com.google.common.hash.HashCode> precomputedHash)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.sourcepath.BuildTargetSourcePath

getTarget, representationForRuleKey

Methods inherited from interface com.facebook.buck.core.sourcepath.SourcePath

compareClasses

Constructor Detail

ExplicitBuildTargetSourcePath

public ExplicitBuildTargetSourcePath()

Method Detail

of

public static ExplicitBuildTargetSourcePath of(BuildTarget target,
                                               Path resolvedPath)

Construct a new immutable ExplicitBuildTargetSourcePath instance.

Parameters:

target - The value for the target attribute

resolvedPath - The value for the resolvedPath attribute

Returns:

An immutable ExplicitBuildTargetSourcePath instance pointing to the given target's default outputs

of

public static ExplicitBuildTargetSourcePath of(BuildTargetWithOutputs target,
                                               Path resolvedPath)

Construct a new immutable ExplicitBuildTargetSourcePath instance.

Parameters:

target - The BuildTargetWithOutputs associated with this SourcePath

resolvedPath - The value for the resolvedPath attribute

Returns:

An immutable ExplicitBuildTargetSourcePath instance pointing to outputs associated with the given targetWithOutputs

of

public static ExplicitBuildTargetSourcePath of(BuildTargetWithOutputs targetWithOutputs,
                                               Path resolvedPath,
                                               Optional<? extends com.google.common.hash.HashCode> precomputedHash)

getTargetWithOutputs

public abstract BuildTargetWithOutputs getTargetWithOutputs()

Specified by:

getTargetWithOutputs in interface BuildTargetSourcePath

Returns:

the BuildTargetWithOutputs this SourcePath is associated with

getResolvedPath

public abstract Path getResolvedPath()

getPrecomputedHash

public abstract Optional<com.google.common.hash.HashCode> getPrecomputedHash()

Description copied from interface: BuildTargetSourcePath

In rare cases, a BuildTargetSourcePath may know a hash of its content on disk before it even creates its output. In this case, we can skip hashing its output files entirely and simply use this precomputed hash code. Use Optional.empty() in the common case.

Specified by:

getPrecomputedHash in interface BuildTargetSourcePath

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(SourcePath other)

Specified by:

compareTo in interface Comparable<SourcePath>