com.facebook.buck.jvm.java

Interface JavacPluginArgs

All Superinterfaces:

BuildRuleArg, ConstructorArg, DataTransferObject, HasDeclaredDeps

public interface JavacPluginArgs
extends BuildRuleArg, HasDeclaredDeps

Constructor arg of javac plugin rule

Field Summary

Fields inherited from interface com.facebook.buck.core.description.arg.BuildRuleArg

DEFAULT_TARGET_PLATFORM_PARAM_NAME

Method Summary

Modifier and Type	Method and Description
default boolean	isDoesNotAffectAbi() A value of false indicates that the plugin either generates classes that are intended for use outside of the code being processed or modifies bytecode in a way that modifies ABI.
default boolean	isIsolateClassLoader() A value of false indicates that the plugin will not use a shared class loader to be loaded.
default boolean	isSupportsAbiGenerationFromSource() If true, allows ABI-affecting plugins to run during ABI generation from source.

Methods inherited from interface com.facebook.buck.core.description.arg.BuildRuleArg

getCompatibleWith, getDefaultTargetPlatform, getLabels, getLicenses, labelsContainsAnyOf

Methods inherited from interface com.facebook.buck.core.description.arg.ConstructorArg

getName

Methods inherited from interface com.facebook.buck.core.description.arg.HasDeclaredDeps

getDeps

Method Detail

isIsolateClassLoader

@Value.Default
default boolean isIsolateClassLoader()

A value of false indicates that the plugin will not use a shared class loader to be loaded. This should be true if the same instance of the plugin has not support to run concurrently multiple times for different javac calls.

Defaults to false because that's the "safe" value and optimizes build time.

isDoesNotAffectAbi

@Value.Default
default boolean isDoesNotAffectAbi()

A value of false indicates that the plugin either generates classes that are intended for use outside of the code being processed or modifies bytecode in a way that modifies ABI. Plugins that affect the ABI of the rule in which they run must be run during ABI generation from source.

Defaults to false because that's the "safe" value. When migrating to ABI generation from source, having as few ABI-affecting plugins as possible will yield the fastest ABI generation.

isSupportsAbiGenerationFromSource

@Value.Default
default boolean isSupportsAbiGenerationFromSource()

If true, allows ABI-affecting plugins to run during ABI generation from source. To run during ABI generation from source, a plugin must meet all of the following criteria:

Uses only the public APIs from JSR-269 (for annotation processing). Access to the Compiler Tree API may also be possible via a Buck support library.

Does not require details about types beyond those being compiled as a general rule. There are ways to ensure type information is available on a case by case basis, at some performance cost.

Defaults to false because that's the "safe" value. When migrating to ABI generation from source, having as many ABI-affecting plugins as possible running during ABI generation will result in the flattest build graph.