ApkGenruleDescriptionArg (Buck)

java.lang.Object
- com.facebook.buck.android.ApkGenruleDescriptionArg

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

Immutable implementation of ApkGenruleDescription.AbstractApkGenruleDescriptionArg.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ApkGenruleDescriptionArg.Builder
Builds instances of type ApkGenruleDescriptionArg.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApkGenruleDescriptionArg.Builder` Builds instances of type `ApkGenruleDescriptionArg`.

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 Default Methods
Modifier and Type	Method and Description
`static ApkGenruleDescriptionArg.Builder`	`builder()` Creates a builder for `ApkGenruleDescriptionArg`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ApkGenruleDescriptionArg` that have equal attribute values.
`BuildTarget`	`getApk()`
`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 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.
`Optional<Boolean>`	`getEnableSandbox()`
`Optional<String>`	`getEnvironmentExpansionSeparator()`
`boolean`	`getIsCacheable()`
`com.google.common.collect.ImmutableSortedSet<String>`	`getLabels()`
`com.google.common.collect.ImmutableSet<SourcePath>`	`getLicenses()`
`String`	`getName()` Each rule has a name
`Optional<String>`	`getOut()`
`Optional<Boolean>`	`getRemote()` If present and true, requests that Buck run this genrule remotely if possible.
`SourceSet`	`getSrcs()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getTests()`
`default Optional<String>`	`getType()`
`int`	`hashCode()` Computes a hash code from attributes: `out`, `apk`, `isCacheable`, `bash`, `cmd`, `cmdExe`, `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 value `ApkGenruleDescriptionArg` 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
  - getOut
```
public Optional<String> getOut()
```
    Returns:
    
    The value of the out attribute
  - getApk
```
public BuildTarget getApk()
```
    Returns:
    
    The value of the apk attribute
  - getIsCacheable
```
public boolean getIsCacheable()
```
    Returns:
    
    The value of the isCacheable attribute
  - getBash
```
public Optional<StringWithMacros> getBash()
```
    Returns:
    
    The value of the bash attribute
  - getCmd
```
public Optional<StringWithMacros> getCmd()
```
    Returns:
    
    The value of the cmd attribute
  - getCmdExe
```
public Optional<StringWithMacros> getCmdExe()
```
    Returns:
    
    The value of the cmdExe attribute
  - getSrcs
```
public SourceSet getSrcs()
```
    Returns:
    
    The value of the srcs attribute
  - getEnableSandbox
```
public Optional<Boolean> getEnableSandbox()
```
    Returns:
    
    The value of the enableSandbox attribute
  - getEnvironmentExpansionSeparator
```
public Optional<String> getEnvironmentExpansionSeparator()
```
    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.
  - 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 what BuildRule#isCacheable does with respect to caching if you decide to use this attribute
  - isNeedAndroidTools
```
public boolean isNeedAndroidTools()
```
    This argument allows genrule to specify if it needs android tools (like dex, aapt, ndk, sdk).
  - 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
  - getTests
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()
```
    Returns:
    
    A list of tests of this target.
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ApkGenruleDescriptionArg 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: out, apk, isCacheable, bash, cmd, cmdExe, srcs, enableSandbox, environmentExpansionSeparator, remote, cacheable, needAndroidTools, licenses, labels, defaultTargetPlatform, compatibleWith, name, tests.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ApkGenruleDescriptionArg with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static ApkGenruleDescriptionArg.Builder builder()
```
    Creates a builder for ApkGenruleDescriptionArg.
    
    Returns:
    
    A new ApkGenruleDescriptionArg builder
  - getType
```
public Optional<String> getType()
```
    Specified by:
    
    getType in interface AbstractGenruleDescription.CommonArg

Class ApkGenruleDescriptionArg

Nested Class Summary

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

getOut

getApk

getIsCacheable

getBash

getCmd

getCmdExe

getSrcs

getEnableSandbox

getEnvironmentExpansionSeparator

getRemote

getCacheable

isNeedAndroidTools

getLicenses

getLabels

getDefaultTargetPlatform

getCompatibleWith

getName

getTests

equals

hashCode

toString

builder

getType