com.facebook.buck.core.sourcepath

Class ForwardingBuildTargetSourcePath

java.lang.Object

com.facebook.buck.core.sourcepath.ForwardingBuildTargetSourcePath

All Implemented Interfaces:

BuildTargetSourcePath, SourcePath, Comparable<SourcePath>

public abstract class ForwardingBuildTargetSourcePath
extends Object
implements BuildTargetSourcePath

A BuildTargetSourcePath which resolves to the value of another SourcePath.

Constructor Summary

Constructors

Constructor and Description
ForwardingBuildTargetSourcePath()

Method Summary

Modifier and Type	Method and Description
int	compareTo(SourcePath other)
boolean	equals(Object other)
abstract SourcePath	getDelegate()
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 BuildTargetWithOutputs	getTargetWithOutputs()
int	hashCode()
static ForwardingBuildTargetSourcePath	of(BuildTarget target, SourcePath delegate) Construct a new immutable ForwardingBuildTargetSourcePath instance.
static ForwardingBuildTargetSourcePath	of(BuildTargetWithOutputs target, SourcePath delegate) Construct a new immutable ForwardingBuildTargetSourcePath instance.
static ForwardingBuildTargetSourcePath	of(BuildTargetWithOutputs target, SourcePath delegate, Optional<? extends com.google.common.hash.HashCode> precomputedHash)
String	representationForRuleKey()
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

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

compareClasses

Constructor Detail

ForwardingBuildTargetSourcePath

public ForwardingBuildTargetSourcePath()

Method Detail

of

public static ForwardingBuildTargetSourcePath of(BuildTarget target,
                                                 SourcePath delegate)

Construct a new immutable ForwardingBuildTargetSourcePath instance.

Parameters:

target - The value for the target attribute

delegate - The value for the delegate attribute

Returns:

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

of

public static ForwardingBuildTargetSourcePath of(BuildTargetWithOutputs target,
                                                 SourcePath delegate)

Construct a new immutable ForwardingBuildTargetSourcePath instance.

Parameters:

target - The BuildTargetWithOutputs associated with this SourcePath

delegate - The value for the delegate attribute

Returns:

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

of

public static ForwardingBuildTargetSourcePath of(BuildTargetWithOutputs target,
                                                 SourcePath delegate,
                                                 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

getDelegate

public abstract SourcePath getDelegate()

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>

representationForRuleKey

public String representationForRuleKey()

Specified by:

representationForRuleKey in interface BuildTargetSourcePath

Returns:

a string that is safe to use for rule key calculations, i.e. does not include absolute paths.