com.facebook.buck.jvm.java

Class JavaPluginDescriptionArg

java.lang.Object

com.facebook.buck.jvm.java.JavaPluginDescriptionArg

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class JavaPluginDescriptionArg
extends Object

Immutable implementation of JavaPluginDescription.AbstractJavaPluginDescriptionArg.

Use the builder to create immutable instances: JavaPluginDescriptionArg.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaPluginDescriptionArg.Builder Builds instances of type JavaPluginDescriptionArg.

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
static JavaPluginDescriptionArg.Builder	builder() Creates a builder for JavaPluginDescriptionArg.
boolean	equals(Object another) This instance is equal to all instances of JavaPluginDescriptionArg that have equal attribute values.
com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>	getCompatibleWith() A list of config_setting a target is compatible with.
Optional<UnconfiguredBuildTarget>	getDefaultTargetPlatform() The name of build target default "new" platform: it is used when a platform is not specified either globally or in a target which used this target as a dependency.
com.google.common.collect.ImmutableSortedSet<BuildTarget>	getDeps()
com.google.common.collect.ImmutableSortedSet<String>	getLabels()
com.google.common.collect.ImmutableSet<SourcePath>	getLicenses()
String	getName() Each rule has a name
String	getPluginName()
int	hashCode() Computes a hash code from attributes: pluginName, isolateClassLoader, doesNotAffectAbi, supportsAbiGenerationFromSource, licenses, labels, defaultTargetPlatform, compatibleWith, name, deps.
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.
boolean	isIsolateClassLoader() A value of false indicates that the plugin will not use a shared class loader to be loaded.
boolean	isSupportsAbiGenerationFromSource() If true, allows ABI-affecting plugins to run during ABI generation from source.
String	toString() Prints the immutable value JavaPluginDescriptionArg with attribute values.

Methods inherited from class java.lang.Object

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

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

labelsContainsAnyOf

Method Detail

getPluginName

public String getPluginName()

Returns:

The value of the pluginName attribute

isIsolateClassLoader

public 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

public 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

public 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.

getLicenses

public com.google.common.collect.ImmutableSet<SourcePath> getLicenses()

Returns:

The value of the licenses attribute

getLabels

public com.google.common.collect.ImmutableSortedSet<String> getLabels()

Returns:

The value of the labels attribute

getDefaultTargetPlatform

public Optional<UnconfiguredBuildTarget> getDefaultTargetPlatform()

The name of build target default "new" platform: it is used when a platform is not specified either globally or in a target which used this target as a dependency.

The value is a build target, but we specify it as string, because this function is not actually called, but the attr is fetched by name from the raw (unconfigured) target node.

getCompatibleWith

public com.google.common.collect.ImmutableList<UnconfiguredBuildTarget> getCompatibleWith()

A list of config_setting a target is compatible with.

getName

public String getName()

Each rule has a name

getDeps

public com.google.common.collect.ImmutableSortedSet<BuildTarget> getDeps()

Returns:

The value of the deps attribute

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of JavaPluginDescriptionArg that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: pluginName, isolateClassLoader, doesNotAffectAbi, supportsAbiGenerationFromSource, licenses, labels, defaultTargetPlatform, compatibleWith, name, deps.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JavaPluginDescriptionArg with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static JavaPluginDescriptionArg.Builder builder()

Creates a builder for JavaPluginDescriptionArg.

Returns:

A new JavaPluginDescriptionArg builder