com.facebook.buck.core.toolchain.tool.impl

Class VersionedTool

java.lang.Object

com.facebook.buck.core.toolchain.tool.impl.VersionedTool

All Implemented Interfaces:

AddsToRuleKey, HasCustomInputsLogic, Tool

public abstract class VersionedTool
extends Object
implements Tool, HasCustomInputsLogic

A Tool which only contributes a fixed name and version when appended to a rule key. This class also holds a Path reference to the tool and additional flags used when invoking the tool, which do *not* themselves contribute to the rule key. This is useful in situations such as supporting cross-compilation, in which case the different tools themselves might not be bit-by-bit identical (and, similarly, they might need to invoked with slightly different flags) but we know that they produce identical output, in which case they should also generate identical rule keys.

Constructor Summary

Constructors

Constructor and Description
VersionedTool()

Method Summary

Modifier and Type	Method and Description
<E extends Exception> void	computeInputs(ThrowingConsumer<SourcePath,E> consumer)
com.google.common.collect.ImmutableList<String>	getCommandPrefix(SourcePathResolverAdapter resolver)
com.google.common.collect.ImmutableMap<String,String>	getEnvironment(SourcePathResolverAdapter resolver)
abstract com.google.common.collect.ImmutableList<String>	getExtraArgs() Additional flags that we pass to the tool, but which do *not* contribute to the rule key.
abstract String	getName()
abstract PathSourcePath	getPath() The path to the tool.
abstract String	getVersion()
static VersionedTool	of(String name, PathSourcePath path, String version)
static VersionedTool	of(String name, PathSourcePath path, String version, com.google.common.collect.ImmutableList<String> extraArgs)

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionedTool

public VersionedTool()

Method Detail

getName

public abstract String getName()

getPath

public abstract PathSourcePath getPath()

The path to the tool. The contents or path to the tool do not contribute to the rule key.

getVersion

public abstract String getVersion()

getExtraArgs

public abstract com.google.common.collect.ImmutableList<String> getExtraArgs()

Additional flags that we pass to the tool, but which do *not* contribute to the rule key.

getCommandPrefix

public com.google.common.collect.ImmutableList<String> getCommandPrefix(SourcePathResolverAdapter resolver)

Specified by:

getCommandPrefix in interface Tool

Returns:

the prefix command use to run this tool.

getEnvironment

public com.google.common.collect.ImmutableMap<String,String> getEnvironment(SourcePathResolverAdapter resolver)

Specified by:

getEnvironment in interface Tool

Returns:

the list of environment variables to set when running the command.

computeInputs

public <E extends Exception> void computeInputs(ThrowingConsumer<SourcePath,E> consumer)
                                         throws E extends Exception

Specified by:

computeInputs in interface HasCustomInputsLogic

Throws:

E extends Exception

of

public static VersionedTool of(String name,
                               PathSourcePath path,
                               String version)

of

public static VersionedTool of(String name,
                               PathSourcePath path,
                               String version,
                               com.google.common.collect.ImmutableList<String> extraArgs)