CxxBinaryDescriptionArg (Buck)

java.lang.Object
- com.facebook.buck.cxx.CxxBinaryDescriptionArg

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

Immutable implementation of CxxBinaryDescription.AbstractCxxBinaryDescriptionArg.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CxxBinaryDescriptionArg.Builder
Builds instances of type CxxBinaryDescriptionArg.

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

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 CxxBinaryDescriptionArg.Builder`	`builder()` Creates a builder for `CxxBinaryDescriptionArg`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `CxxBinaryDescriptionArg` that have equal attribute values.
`com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>`	`getCompatibleWith()` A list of `config_setting` a target is compatible with.
`com.google.common.collect.ImmutableList<StringWithMacros>`	`getCompilerFlags()`
`CxxDeps`	`getCxxDeps()`
`Optional<Linker.CxxRuntimeType>`	`getCxxRuntimeType()`
`com.google.common.collect.ImmutableSortedSet<Flavor>`	`getDefaultFlavors()`
`Optional<Flavor>`	`getDefaultPlatform()`
`com.google.common.collect.ImmutableMap<String,Flavor>`	`getDefaults()`
`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()`
`Optional<Query>`	`getDepsQuery()`
`Optional<String>`	`getExecutableName()`
`boolean`	`getFatLto()`
`com.google.common.collect.ImmutableSortedSet<FrameworkPath>`	`getFrameworks()`
`Optional<String>`	`getHeaderNamespace()`
`SourceSortedSet`	`getHeaders()`
`com.google.common.collect.ImmutableSortedSet<String>`	`getIncludeDirectories()` A list of include directories to be added to the compile command for compiling this cxx target.
`com.google.common.collect.ImmutableSortedSet<String>`	`getLabels()`
`com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>>`	`getLangCompilerFlags()`
`com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>>`	`getLangPlatformCompilerFlags()`
`com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>>`	`getLangPlatformPreprocessorFlags()`
`com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>>`	`getLangPreprocessorFlags()`
`com.google.common.collect.ImmutableSortedSet<FrameworkPath>`	`getLibraries()`
`com.google.common.collect.ImmutableSet<SourcePath>`	`getLicenses()`
`boolean`	`getLinkDepsQueryWhole()`
`com.google.common.collect.ImmutableList<String>`	`getLinkerExtraOutputs()`
`com.google.common.collect.ImmutableList<StringWithMacros>`	`getLinkerFlags()`
`Optional<String>`	`getLinkGroup()` Defines the link group.
`Optional<com.google.common.collect.ImmutableList<CxxLinkGroupMapping>>`	`getLinkGroupMap()` Defines the list of link group mappings.
`Optional<Linker.LinkableDepType>`	`getLinkStyle()`
`String`	`getName()` Each rule has a name
`PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>`	`getPlatformCompilerFlags()`
`PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>>`	`getPlatformDeps()`
`PatternMatchedCollection<SourceSortedSet>`	`getPlatformHeaders()`
`PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>`	`getPlatformLinkerFlags()`
`PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>`	`getPlatformPreprocessorFlags()`
`PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<SourceWithFlags>>`	`getPlatformSrcs()`
`com.google.common.collect.ImmutableList<StringWithMacros>`	`getPostLinkerFlags()`
`PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>`	`getPostPlatformLinkerFlags()`
`Optional<SourcePath>`	`getPrecompiledHeader()`
`Optional<SourcePath>`	`getPrefixHeader()`
`com.google.common.collect.ImmutableList<StringWithMacros>`	`getPreprocessorFlags()`
`CxxDeps`	`getPrivateCxxDeps()`
`com.google.common.collect.ImmutableSortedSet<SourcePath>`	`getRawHeaders()` Raw headers are headers which are used as they are (via compilation flags).
`com.google.common.collect.ImmutableSortedSet<SourceWithFlags>`	`getSrcs()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getTests()`
`boolean`	`getThinLto()`
`Optional<String>`	`getVersionUniverse()`
`int`	`hashCode()` Computes a hash code from attributes: `linkDepsQueryWhole`, `linkStyle`, `linkGroupMap`, `linkGroup`, `thinLto`, `fatLto`, `srcs`, `platformSrcs`, `headers`, `rawHeaders`, `includeDirectories`, `platformHeaders`, `prefixHeader`, `precompiledHeader`, `compilerFlags`, `langCompilerFlags`, `langPlatformCompilerFlags`, `platformCompilerFlags`, `preprocessorFlags`, `platformPreprocessorFlags`, `langPreprocessorFlags`, `langPlatformPreprocessorFlags`, `linkerFlags`, `postLinkerFlags`, `linkerExtraOutputs`, `platformLinkerFlags`, `executableName`, `postPlatformLinkerFlags`, `platformDeps`, `headerNamespace`, `cxxRuntimeType`, `defaults`, `defaultFlavors`, `cxxDeps`, `privateCxxDeps`, `licenses`, `labels`, `defaultTargetPlatform`, `compatibleWith`, `name`, `deps`, `defaultPlatform`, `tests`, `frameworks`, `libraries`, `versionUniverse`, `depsQuery`.
`String`	`toString()` Prints the immutable value `CxxBinaryDescriptionArg` with attribute values.
`default CxxBinaryDescriptionArg`	`withDepsQuery(Query query)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.cxx.CxxConstructorArg
checkDuplicateSources, checkHeadersUsage

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

- Method Detail
  - getLinkDepsQueryWhole
```
public boolean getLinkDepsQueryWhole()
```
    Returns:
    
    The value of the linkDepsQueryWhole attribute
  - getLinkStyle
```
public Optional<Linker.LinkableDepType> getLinkStyle()
```
    Returns:
    
    The value of the linkStyle attribute
  - getLinkGroupMap
```
public Optional<com.google.common.collect.ImmutableList<CxxLinkGroupMapping>> getLinkGroupMap()
```
    Defines the list of link group mappings. Targets' membership in a group is defined by the order of the list, so if more than one mapping matches a single target, the group would be the one defined by the first match.
  - getLinkGroup
```
public Optional<String> getLinkGroup()
```
    Defines the link group. When linking executable code, only static libraries which belong to the same group would be linked into the executable.
  - getThinLto
```
public boolean getThinLto()
```
    Returns:
    
    The value of the thinLto attribute
  - getFatLto
```
public boolean getFatLto()
```
    Returns:
    
    The value of the fatLto attribute
  - getSrcs
```
public com.google.common.collect.ImmutableSortedSet<SourceWithFlags> getSrcs()
```
    Returns:
    
    The value of the srcs attribute
  - getPlatformSrcs
```
public PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<SourceWithFlags>> getPlatformSrcs()
```
    Returns:
    
    The value of the platformSrcs attribute
  - getHeaders
```
public SourceSortedSet getHeaders()
```
    Returns:
    
    The value of the headers attribute
  - getRawHeaders
```
public com.google.common.collect.ImmutableSortedSet<SourcePath> getRawHeaders()
```
    Raw headers are headers which are used as they are (via compilation flags). Buck doesn't copy them or create symlinks for them. They are public (since managed by compilation flags).
    
    Returns:
    
    a list of raw headers
  - getIncludeDirectories
```
public com.google.common.collect.ImmutableSortedSet<String> getIncludeDirectories()
```
    A list of include directories to be added to the compile command for compiling this cxx target.
    
    Returns:
    
    a list of private include paths for this cxx target.
  - getPlatformHeaders
```
public PatternMatchedCollection<SourceSortedSet> getPlatformHeaders()
```
    Returns:
    
    The value of the platformHeaders attribute
  - getPrefixHeader
```
public Optional<SourcePath> getPrefixHeader()
```
    Returns:
    
    The value of the prefixHeader attribute
  - getPrecompiledHeader
```
public Optional<SourcePath> getPrecompiledHeader()
```
    Returns:
    
    The value of the precompiledHeader attribute
  - getCompilerFlags
```
public com.google.common.collect.ImmutableList<StringWithMacros> getCompilerFlags()
```
    Returns:
    
    The value of the compilerFlags attribute
  - getLangCompilerFlags
```
public com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>> getLangCompilerFlags()
```
    Returns:
    
    The value of the langCompilerFlags attribute
  - getLangPlatformCompilerFlags
```
public com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>> getLangPlatformCompilerFlags()
```
    Returns:
    
    The value of the langPlatformCompilerFlags attribute
  - getPlatformCompilerFlags
```
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformCompilerFlags()
```
    Returns:
    
    The value of the platformCompilerFlags attribute
  - getPreprocessorFlags
```
public com.google.common.collect.ImmutableList<StringWithMacros> getPreprocessorFlags()
```
    Returns:
    
    The value of the preprocessorFlags attribute
  - getPlatformPreprocessorFlags
```
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformPreprocessorFlags()
```
    Returns:
    
    The value of the platformPreprocessorFlags attribute
  - getLangPreprocessorFlags
```
public com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>> getLangPreprocessorFlags()
```
    Returns:
    
    The value of the langPreprocessorFlags attribute
  - getLangPlatformPreprocessorFlags
```
public com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>> getLangPlatformPreprocessorFlags()
```
    Returns:
    
    The value of the langPlatformPreprocessorFlags attribute
  - getLinkerFlags
```
public com.google.common.collect.ImmutableList<StringWithMacros> getLinkerFlags()
```
    Returns:
    
    The value of the linkerFlags attribute
  - getPostLinkerFlags
```
public com.google.common.collect.ImmutableList<StringWithMacros> getPostLinkerFlags()
```
    Returns:
    
    The value of the postLinkerFlags attribute
  - getLinkerExtraOutputs
```
public com.google.common.collect.ImmutableList<String> getLinkerExtraOutputs()
```
    Returns:
    
    The value of the linkerExtraOutputs attribute
  - getPlatformLinkerFlags
```
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformLinkerFlags()
```
    Returns:
    
    The value of the platformLinkerFlags attribute
  - getExecutableName
```
public Optional<String> getExecutableName()
```
    Returns:
    
    The value of the executableName attribute
  - getPostPlatformLinkerFlags
```
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPostPlatformLinkerFlags()
```
    Returns:
    
    The value of the postPlatformLinkerFlags attribute
  - getPlatformDeps
```
public PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>> getPlatformDeps()
```
    Returns:
    
    The value of the platformDeps attribute
  - getHeaderNamespace
```
public Optional<String> getHeaderNamespace()
```
    Returns:
    
    The value of the headerNamespace attribute
  - getCxxRuntimeType
```
public Optional<Linker.CxxRuntimeType> getCxxRuntimeType()
```
    Returns:
    
    The value of the cxxRuntimeType attribute
  - getDefaults
```
public com.google.common.collect.ImmutableMap<String,Flavor> getDefaults()
```
    Returns:
    
    The value of the defaults attribute
  - getDefaultFlavors
```
public com.google.common.collect.ImmutableSortedSet<Flavor> getDefaultFlavors()
```
    Returns:
    
    The computed-at-construction value of the defaultFlavors attribute
  - getCxxDeps
```
public CxxDeps getCxxDeps()
```
    Returns:
    
    the C/C++ deps this rule builds against.
  - getPrivateCxxDeps
```
public CxxDeps getPrivateCxxDeps()
```
    Returns:
    
    C/C++ deps which are *not* propagated to dependents.
  - 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
  - getDefaultPlatform
```
public Optional<Flavor> getDefaultPlatform()
```
    Returns:
    
    If present, the default platform with which to build this target if none are provided on the command line.
  - getTests
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()
```
    Returns:
    
    A list of tests of this target.
  - getFrameworks
```
public com.google.common.collect.ImmutableSortedSet<FrameworkPath> getFrameworks()
```
    Returns:
    
    The value of the frameworks attribute
  - getLibraries
```
public com.google.common.collect.ImmutableSortedSet<FrameworkPath> getLibraries()
```
    Returns:
    
    The value of the libraries attribute
  - getVersionUniverse
```
public Optional<String> getVersionUniverse()
```
    Returns:
    
    The value of the versionUniverse attribute
  - getDepsQuery
```
public Optional<Query> getDepsQuery()
```
    Returns:
    
    The value of the depsQuery attribute
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of CxxBinaryDescriptionArg 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: linkDepsQueryWhole, linkStyle, linkGroupMap, linkGroup, thinLto, fatLto, srcs, platformSrcs, headers, rawHeaders, includeDirectories, platformHeaders, prefixHeader, precompiledHeader, compilerFlags, langCompilerFlags, langPlatformCompilerFlags, platformCompilerFlags, preprocessorFlags, platformPreprocessorFlags, langPreprocessorFlags, langPlatformPreprocessorFlags, linkerFlags, postLinkerFlags, linkerExtraOutputs, platformLinkerFlags, executableName, postPlatformLinkerFlags, platformDeps, headerNamespace, cxxRuntimeType, defaults, defaultFlavors, cxxDeps, privateCxxDeps, licenses, labels, defaultTargetPlatform, compatibleWith, name, deps, defaultPlatform, tests, frameworks, libraries, versionUniverse, depsQuery.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CxxBinaryDescriptionArg with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static CxxBinaryDescriptionArg.Builder builder()
```
    Creates a builder for CxxBinaryDescriptionArg.
    
    Returns:
    
    A new CxxBinaryDescriptionArg builder
  - withDepsQuery
```
public CxxBinaryDescriptionArg withDepsQuery(Query query)
```
    Specified by:
    
    withDepsQuery in interface HasDepsQuery

Class CxxBinaryDescriptionArg

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.cxx.CxxConstructorArg

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

Method Detail

getLinkDepsQueryWhole

getLinkStyle

getLinkGroupMap

getLinkGroup

getThinLto

getFatLto

getSrcs

getPlatformSrcs

getHeaders

getRawHeaders

getIncludeDirectories

getPlatformHeaders

getPrefixHeader

getPrecompiledHeader

getCompilerFlags

getLangCompilerFlags

getLangPlatformCompilerFlags

getPlatformCompilerFlags

getPreprocessorFlags

getPlatformPreprocessorFlags

getLangPreprocessorFlags

getLangPlatformPreprocessorFlags

getLinkerFlags

getPostLinkerFlags

getLinkerExtraOutputs

getPlatformLinkerFlags

getExecutableName

getPostPlatformLinkerFlags

getPlatformDeps

getHeaderNamespace

getCxxRuntimeType

getDefaults

getDefaultFlavors

getCxxDeps

getPrivateCxxDeps

getLicenses

getLabels

getDefaultTargetPlatform

getCompatibleWith

getName

getDeps

getDefaultPlatform

getTests

getFrameworks

getLibraries

getVersionUniverse

getDepsQuery

equals

hashCode

toString

builder

withDepsQuery