Package com.facebook.buck.jvm.java
Class JarGenruleDescriptionArg
- java.lang.Object
-
- com.facebook.buck.jvm.java.JarGenruleDescriptionArg
-
- All Implemented Interfaces:
BuildRuleArg
,ConstructorArg
,DataTransferObject
,HasTests
,AbstractGenruleDescription.CommonArg
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class JarGenruleDescriptionArg extends Object
jar_genrule constructor arg.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
JarGenruleDescriptionArg.Builder
Builds instances of typeJarGenruleDescriptionArg
.
-
Field Summary
-
Fields inherited from interface com.facebook.buck.core.description.arg.BuildRuleArg
DEFAULT_TARGET_PLATFORM_PARAM_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JarGenruleDescriptionArg.Builder
builder()
Creates a builder forJarGenruleDescriptionArg
.boolean
equals(Object another)
This instance is equal to all instances ofJarGenruleDescriptionArg
that have equal attribute values.Optional<StringWithMacros>
getBash()
Optional<Boolean>
getCacheable()
This functionality only exists to get around the lack of extensibility in our current build rule / build file apis.Optional<StringWithMacros>
getCmd()
Optional<StringWithMacros>
getCmdExe()
com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>
getCompatibleWith()
A list ofconfig_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.Optional<Boolean>
getEnableSandbox()
Optional<String>
getEnvironmentExpansionSeparator()
com.google.common.collect.ImmutableSortedSet<String>
getLabels()
com.google.common.collect.ImmutableSet<SourcePath>
getLicenses()
String
getName()
Each rule has a nameOptional<Boolean>
getRemote()
If present and true, requests that Buck run this genrule remotely if possible.SourceSet
getSrcs()
com.google.common.collect.ImmutableSortedSet<BuildTarget>
getTests()
Optional<String>
getType()
int
hashCode()
Computes a hash code from attributes:bash
,cmd
,cmdExe
,type
,srcs
,enableSandbox
,environmentExpansionSeparator
,remote
,cacheable
,needAndroidTools
,licenses
,labels
,defaultTargetPlatform
,compatibleWith
,name
,tests
.boolean
isNeedAndroidTools()
This argument allows genrule to specify if it needs android tools (like dex, aapt, ndk, sdk).String
toString()
Prints the immutable valueJarGenruleDescriptionArg
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
-
getBash
public Optional<StringWithMacros> getBash()
- Specified by:
getBash
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
bash
attribute
-
getCmd
public Optional<StringWithMacros> getCmd()
- Specified by:
getCmd
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
cmd
attribute
-
getCmdExe
public Optional<StringWithMacros> getCmdExe()
- Specified by:
getCmdExe
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
cmdExe
attribute
-
getType
public Optional<String> getType()
- Specified by:
getType
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
type
attribute
-
getSrcs
public SourceSet getSrcs()
- Specified by:
getSrcs
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
srcs
attribute
-
getEnableSandbox
public Optional<Boolean> getEnableSandbox()
- Specified by:
getEnableSandbox
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
enableSandbox
attribute
-
getEnvironmentExpansionSeparator
public Optional<String> getEnvironmentExpansionSeparator()
- Specified by:
getEnvironmentExpansionSeparator
in interfaceAbstractGenruleDescription.CommonArg
- Returns:
- The value of the
environmentExpansionSeparator
attribute
-
getRemote
public Optional<Boolean> getRemote()
If present and true, requests that Buck run this genrule remotely if possible. Defaults to false for now.- Specified by:
getRemote
in interfaceAbstractGenruleDescription.CommonArg
-
getCacheable
public Optional<Boolean> getCacheable()
This functionality only exists to get around the lack of extensibility in our current build rule / build file apis. It may go away at some point. Also, make sure that you understand whatBuildRule#isCacheable
does with respect to caching if you decide to use this attribute- Specified by:
getCacheable
in interfaceAbstractGenruleDescription.CommonArg
-
isNeedAndroidTools
public boolean isNeedAndroidTools()
This argument allows genrule to specify if it needs android tools (like dex, aapt, ndk, sdk).- Specified by:
isNeedAndroidTools
in interfaceAbstractGenruleDescription.CommonArg
-
getLicenses
public com.google.common.collect.ImmutableSet<SourcePath> getLicenses()
- Specified by:
getLicenses
in interfaceBuildRuleArg
- Returns:
- The value of the
licenses
attribute
-
getLabels
public com.google.common.collect.ImmutableSortedSet<String> getLabels()
- Specified by:
getLabels
in interfaceBuildRuleArg
- 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.
- Specified by:
getDefaultTargetPlatform
in interfaceBuildRuleArg
-
getCompatibleWith
public com.google.common.collect.ImmutableList<UnconfiguredBuildTarget> getCompatibleWith()
A list ofconfig_setting
a target is compatible with.- Specified by:
getCompatibleWith
in interfaceBuildRuleArg
-
getName
public String getName()
Each rule has a name- Specified by:
getName
in interfaceConstructorArg
-
getTests
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()
-
equals
public boolean equals(@Nullable Object another)
This instance is equal to all instances ofJarGenruleDescriptionArg
that have equal attribute values.
-
hashCode
public int hashCode()
Computes a hash code from attributes:bash
,cmd
,cmdExe
,type
,srcs
,enableSandbox
,environmentExpansionSeparator
,remote
,cacheable
,needAndroidTools
,licenses
,labels
,defaultTargetPlatform
,compatibleWith
,name
,tests
.
-
toString
public String toString()
Prints the immutable valueJarGenruleDescriptionArg
with attribute values.
-
builder
public static JarGenruleDescriptionArg.Builder builder()
Creates a builder forJarGenruleDescriptionArg
.- Returns:
- A new JarGenruleDescriptionArg builder
-
-