com.facebook.buck.core.toolchain

Interface ToolchainProvider

All Known Implementing Classes:

BaseToolchainProvider, DefaultToolchainProvider

public interface ToolchainProvider

An interface that give access to specific toolchains by toolchain name.

Method Summary

Modifier and Type	Method and Description
Toolchain	getByName(String toolchainName, TargetConfiguration toolchainTargetConfiguration)
<T extends Toolchain> T	getByName(String toolchainName, TargetConfiguration toolchainTargetConfiguration, Class<T> toolchainClass)
<T extends Toolchain> Optional<T>	getByNameIfPresent(String toolchainName, TargetConfiguration toolchainTargetConfiguration, Class<T> toolchainClass)
Optional<ToolchainInstantiationException>	getToolchainInstantiationException(String toolchainName, TargetConfiguration toolchainTargetConfiguration)
<T extends ToolchainWithCapability> Collection<String>	getToolchainsWithCapability(Class<T> capability) Provides access to all known toolchains that support the provided capability.
boolean	isToolchainCreated(String toolchainName, TargetConfiguration toolchainTargetConfiguration)
boolean	isToolchainFailed(String toolchainName, TargetConfiguration toolchainTargetConfiguration)
boolean	isToolchainPresent(String toolchainName, TargetConfiguration toolchainTargetConfiguration)

Method Detail

getByName

Toolchain getByName(String toolchainName,
                    TargetConfiguration toolchainTargetConfiguration)

Throws:

ToolchainInstantiationException - when a toolchain cannot be created

getByName

<T extends Toolchain> T getByName(String toolchainName,
                                  TargetConfiguration toolchainTargetConfiguration,
                                  Class<T> toolchainClass)

Throws:

ToolchainInstantiationException - when a toolchain cannot be created

getByNameIfPresent

<T extends Toolchain> Optional<T> getByNameIfPresent(String toolchainName,
                                                     TargetConfiguration toolchainTargetConfiguration,
                                                     Class<T> toolchainClass)

isToolchainPresent

boolean isToolchainPresent(String toolchainName,
                           TargetConfiguration toolchainTargetConfiguration)

Returns:

true if toolchain exists (triggering instantiation if needed)

isToolchainCreated

boolean isToolchainCreated(String toolchainName,
                           TargetConfiguration toolchainTargetConfiguration)

Returns:

true if toolchain has already been created (without triggering instantiation)

isToolchainFailed

boolean isToolchainFailed(String toolchainName,
                          TargetConfiguration toolchainTargetConfiguration)

Returns:

true if toolchain failed to instantiate (without triggering instantiation)

getToolchainsWithCapability

<T extends ToolchainWithCapability> Collection<String> getToolchainsWithCapability(Class<T> capability)

Provides access to all known toolchains that support the provided capability.

The toolchains are not created during the execution of this method.

Returns:

a collection of toolchain names that support the provided capability.

getToolchainInstantiationException

Optional<ToolchainInstantiationException> getToolchainInstantiationException(String toolchainName,
                                                                             TargetConfiguration toolchainTargetConfiguration)

Returns:

the exception that was thrown during toolchain instantiation