CxxToolchainDescriptionArg (Buck)

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

```
@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class CxxToolchainDescriptionArg
extends Object
```
This is roughly analagous to the configuration provided by CxxBuckConfig. Some things are not yet exposed/implemented, and others have been slightly renamed or exposed slightly differently to be more restricted or more descriptive or more maintainable.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CxxToolchainDescriptionArg.Builder
Builds instances of type CxxToolchainDescriptionArg.

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

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 and Description
`static CxxToolchainDescriptionArg.Builder`	`builder()` Creates a builder for `CxxToolchainDescriptionArg`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `CxxToolchainDescriptionArg` that have equal attribute values.
`SourcePath`	`getArchiver()` Archiver binary.
`com.google.common.collect.ImmutableList<String>`	`getArchiverFlags()` Archiver flags.
`ArchiverProvider.Type`	`getArchiverType()` `ArchiverProvider.Type` of the archiver.
`SourcePath`	`getAssembler()` Assembler binary.
`com.google.common.collect.ImmutableList<String>`	`getAssemblerFlags()` Flags for the assembler.
`Optional<String>`	`getBinaryExtension()` Extension for binary files.
`SourcePath`	`getCCompiler()` C compiler binary.
`com.google.common.collect.ImmutableList<String>`	`getCCompilerFlags()` C compiler flags.
`com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>`	`getCompatibleWith()` A list of `config_setting` a target is compatible with.
`CxxToolProvider.Type`	`getCompilerType()` `CxxToolProvider.Type` of the compiler.
`SourcePath`	`getCxxCompiler()` C++ compiler binary.
`com.google.common.collect.ImmutableList<String>`	`getCxxCompilerFlags()` C++ compiler flags.
`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.
`boolean`	`getFilepathLengthLimited()` Whether to use shorter intermediate files.
`com.google.common.collect.ImmutableList<String>`	`getHeadersWhitelist()` A list of regexes which match headers (belonging to the toolchain) to exempt from untracked header verification.
`com.google.common.collect.ImmutableSortedSet<String>`	`getLabels()`
`com.google.common.collect.ImmutableSet<SourcePath>`	`getLicenses()`
`SourcePath`	`getLinker()` Linker binary.
`com.google.common.collect.ImmutableList<String>`	`getLinkerFlags()` Linker flags.
`LinkerProvider.Type`	`getLinkerType()` `LinkerProvider.Type` of the linker.
`String`	`getName()` Each rule has a name
`SourcePath`	`getNm()` nm binary.
`SourcePath`	`getObjcopyForSharedLibraryInterface()` Objcopy binary to use for creating shared library interfaces.
`String`	`getObjectFileExtension()` Extension for object files.
`boolean`	`getPrivateHeadersSymlinksEnabled()` When building or creating a project, create symlinks for the public headers if it's true.
`boolean`	`getPublicHeadersSymlinksEnabled()` When building or creating a project, create symlinks for the public headers if it's true.
`Optional<SourcePath>`	`getRanlib()` Ranlib binary.
`com.google.common.collect.ImmutableList<String>`	`getRanlibFlags()` Ranlib flags.
`com.google.common.collect.ImmutableList<String>`	`getSharedDepRuntimeLdFlags()` Flags for linking the c/c++ runtime for shared libraries.
`String`	`getSharedLibraryExtension()` Extension of shared library files.
`SharedLibraryInterfaceParams.Type`	`getSharedLibraryInterfaceType()` Type of shared library interfaces to create.
`String`	`getSharedLibraryVersionedExtensionFormat()` Extension format for versioned shared libraries.
`com.google.common.collect.ImmutableList<String>`	`getStaticDepRuntimeLdFlags()` Flags for linking the c/c++ runtime for static libraries.
`String`	`getStaticLibraryExtension()` Extension for static library files.
`com.google.common.collect.ImmutableList<String>`	`getStaticPicDepRuntimeLdFlags()` Flags for linking the c/c++ runtime for static-pic libraries.
`SourcePath`	`getStrip()` Strip binary.
`com.google.common.collect.ImmutableList<String>`	`getStripFlags()` Strip flags.
`boolean`	`getUseArgFile()` Whether to use an argfile for long command lines.
`boolean`	`getUseHeaderMap()` Whether to use header maps.
`int`	`hashCode()` Computes a hash code from attributes: `privateHeadersSymlinksEnabled`, `publicHeadersSymlinksEnabled`, `useArgFile`, `sharedLibraryExtension`, `sharedLibraryVersionedExtensionFormat`, `staticLibraryExtension`, `objectFileExtension`, `binaryExtension`, `compilerType`, `linkerType`, `assembler`, `assemblerFlags`, `cCompiler`, `cCompilerFlags`, `cxxCompiler`, `cxxCompilerFlags`, `linker`, `linkerFlags`, `archiver`, `archiverFlags`, `archiverType`, `strip`, `ranlib`, `ranlibFlags`, `stripFlags`, `staticDepRuntimeLdFlags`, `staticPicDepRuntimeLdFlags`, `sharedDepRuntimeLdFlags`, `nm`, `sharedLibraryInterfaceType`, `objcopyForSharedLibraryInterface`, `useHeaderMap`, `filepathLengthLimited`, `headersWhitelist`, `licenses`, `labels`, `defaultTargetPlatform`, `compatibleWith`, `name`.
`String`	`toString()` Prints the immutable value `CxxToolchainDescriptionArg` 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
  - getPrivateHeadersSymlinksEnabled
```
public boolean getPrivateHeadersSymlinksEnabled()
```
    When building or creating a project, create symlinks for the public headers if it's true.
  - getPublicHeadersSymlinksEnabled
```
public boolean getPublicHeadersSymlinksEnabled()
```
    When building or creating a project, create symlinks for the public headers if it's true. It would allow public headers to include an other public header with #include "foobar.h"\ even if it's not in the same folder.
  - getUseArgFile
```
public boolean getUseArgFile()
```
    Whether to use an argfile for long command lines.
  - getSharedLibraryExtension
```
public String getSharedLibraryExtension()
```
    Extension of shared library files.
  - getSharedLibraryVersionedExtensionFormat
```
public String getSharedLibraryVersionedExtensionFormat()
```
    Extension format for versioned shared libraries.
  - getStaticLibraryExtension
```
public String getStaticLibraryExtension()
```
    Extension for static library files.
  - getObjectFileExtension
```
public String getObjectFileExtension()
```
    Extension for object files.
  - getBinaryExtension
```
public Optional<String> getBinaryExtension()
```
    Extension for binary files.
  - getCompilerType
```
public CxxToolProvider.Type getCompilerType()
```
    CxxToolProvider.Type of the compiler.
  - getLinkerType
```
public LinkerProvider.Type getLinkerType()
```
    LinkerProvider.Type of the linker.
  - getAssembler
```
public SourcePath getAssembler()
```
    Assembler binary.
  - getAssemblerFlags
```
public com.google.common.collect.ImmutableList<String> getAssemblerFlags()
```
    Flags for the assembler.
  - getCCompiler
```
public SourcePath getCCompiler()
```
    C compiler binary.
  - getCCompilerFlags
```
public com.google.common.collect.ImmutableList<String> getCCompilerFlags()
```
    C compiler flags.
  - getCxxCompiler
```
public SourcePath getCxxCompiler()
```
    C++ compiler binary.
  - getCxxCompilerFlags
```
public com.google.common.collect.ImmutableList<String> getCxxCompilerFlags()
```
    C++ compiler flags.
  - getLinker
```
public SourcePath getLinker()
```
    Linker binary.
  - getLinkerFlags
```
public com.google.common.collect.ImmutableList<String> getLinkerFlags()
```
    Linker flags.
  - getArchiver
```
public SourcePath getArchiver()
```
    Archiver binary.
  - getArchiverFlags
```
public com.google.common.collect.ImmutableList<String> getArchiverFlags()
```
    Archiver flags.
  - getArchiverType
```
public ArchiverProvider.Type getArchiverType()
```
    ArchiverProvider.Type of the archiver.
  - getStrip
```
public SourcePath getStrip()
```
    Strip binary.
  - getRanlib
```
public Optional<SourcePath> getRanlib()
```
    Ranlib binary.
  - getRanlibFlags
```
public com.google.common.collect.ImmutableList<String> getRanlibFlags()
```
    Ranlib flags.
  - getStripFlags
```
public com.google.common.collect.ImmutableList<String> getStripFlags()
```
    Strip flags.
  - getStaticDepRuntimeLdFlags
```
public com.google.common.collect.ImmutableList<String> getStaticDepRuntimeLdFlags()
```
    Flags for linking the c/c++ runtime for static libraries.
  - getStaticPicDepRuntimeLdFlags
```
public com.google.common.collect.ImmutableList<String> getStaticPicDepRuntimeLdFlags()
```
    Flags for linking the c/c++ runtime for static-pic libraries.
  - getSharedDepRuntimeLdFlags
```
public com.google.common.collect.ImmutableList<String> getSharedDepRuntimeLdFlags()
```
    Flags for linking the c/c++ runtime for shared libraries.
  - getNm
```
public SourcePath getNm()
```
    nm binary.
  - getSharedLibraryInterfaceType
```
public SharedLibraryInterfaceParams.Type getSharedLibraryInterfaceType()
```
    Type of shared library interfaces to create.
  - getObjcopyForSharedLibraryInterface
```
public SourcePath getObjcopyForSharedLibraryInterface()
```
    Objcopy binary to use for creating shared library interfaces.
  - getUseHeaderMap
```
public boolean getUseHeaderMap()
```
    Whether to use header maps.
  - getFilepathLengthLimited
```
public boolean getFilepathLengthLimited()
```
    Whether to use shorter intermediate files.
  - getHeadersWhitelist
```
public com.google.common.collect.ImmutableList<String> getHeadersWhitelist()
```
    A list of regexes which match headers (belonging to the toolchain) to exempt from untracked header verification.
  - 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
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of CxxToolchainDescriptionArg 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: privateHeadersSymlinksEnabled, publicHeadersSymlinksEnabled, useArgFile, sharedLibraryExtension, sharedLibraryVersionedExtensionFormat, staticLibraryExtension, objectFileExtension, binaryExtension, compilerType, linkerType, assembler, assemblerFlags, cCompiler, cCompilerFlags, cxxCompiler, cxxCompilerFlags, linker, linkerFlags, archiver, archiverFlags, archiverType, strip, ranlib, ranlibFlags, stripFlags, staticDepRuntimeLdFlags, staticPicDepRuntimeLdFlags, sharedDepRuntimeLdFlags, nm, sharedLibraryInterfaceType, objcopyForSharedLibraryInterface, useHeaderMap, filepathLengthLimited, headersWhitelist, licenses, labels, defaultTargetPlatform, compatibleWith, name.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CxxToolchainDescriptionArg with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static CxxToolchainDescriptionArg.Builder builder()
```
    Creates a builder for CxxToolchainDescriptionArg.
    
    Returns:
    
    A new CxxToolchainDescriptionArg builder

Class CxxToolchainDescriptionArg

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

getPrivateHeadersSymlinksEnabled

getPublicHeadersSymlinksEnabled

getUseArgFile

getSharedLibraryExtension

getSharedLibraryVersionedExtensionFormat

getStaticLibraryExtension

getObjectFileExtension

getBinaryExtension

getCompilerType

getLinkerType

getAssembler

getAssemblerFlags

getCCompiler

getCCompilerFlags

getCxxCompiler

getCxxCompilerFlags

getLinker

getLinkerFlags

getArchiver

getArchiverFlags

getArchiverType

getStrip

getRanlib

getRanlibFlags

getStripFlags

getStaticDepRuntimeLdFlags

getStaticPicDepRuntimeLdFlags

getSharedDepRuntimeLdFlags

getNm

getSharedLibraryInterfaceType

getObjcopyForSharedLibraryInterface

getUseHeaderMap

getFilepathLengthLimited

getHeadersWhitelist

getLicenses

getLabels

getDefaultTargetPlatform

getCompatibleWith

getName

equals

hashCode

toString

builder