KotlinLibraryDescriptionArg (Buck)

java.lang.Object
- com.facebook.buck.jvm.kotlin.KotlinLibraryDescriptionArg

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

Immutable implementation of KotlinLibraryDescription.AbstractKotlinLibraryDescriptionArg.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class KotlinLibraryDescriptionArg.Builder
Builds instances of type KotlinLibraryDescriptionArg.

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

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 KotlinLibraryDescriptionArg.Builder`	`builder()` Creates a builder for `KotlinLibraryDescriptionArg`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `KotlinLibraryDescriptionArg` that have equal attribute values.
`Optional<AbiGenerationMode>`	`getAbiGenerationMode()`
`boolean`	`getAllWarningsAsErrors()` Report an error if there are any warnings.
`Optional<KotlinLibraryDescription.AnnotationProcessingTool>`	`getAnnotationProcessingTool()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getAnnotationProcessorDeps()`
`Optional<Boolean>`	`getAnnotationProcessorOnly()`
`com.google.common.collect.ImmutableList<String>`	`getAnnotationProcessorParams()`
`com.google.common.collect.ImmutableSet<String>`	`getAnnotationProcessors()`
`Optional<String>`	`getApiVersion()` Allow to use declarations only from the specified version of bundled libraries.
`com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>`	`getCompatibleWith()` A list of `config_setting` a target is compatible with.
`Optional<CompileAgainstLibraryType>`	`getCompileAgainst()`
`Optional<Either<BuiltInJavac,SourcePath>>`	`getCompiler()`
`Optional<String>`	`getCompilerClassName()`
`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<BuildTarget>`	`getExportedDeps()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getExportedProvidedDeps()`
`com.google.common.collect.ImmutableList<String>`	`getExtraArguments()`
`com.google.common.collect.ImmutableList<String>`	`getFreeCompilerArgs()` A list of additional compiler arguments.
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getFriendPaths()`
`boolean`	`getIncludeRuntime()` Include Kotlin runtime in to resulting .jar
`Optional<SourcePath>`	`getJavac()`
`Optional<SourcePath>`	`getJavacJar()`
`boolean`	`getJavaParameters()` Generate metadata for Java 1.8 reflection on method parameters.
`com.google.common.collect.ImmutableList<String>`	`getJavaPluginParams()`
`Optional<String>`	`getJavaVersion()`
`Optional<String>`	`getJdkHome()` Path to JDK home directory to include into classpath, if differs from default JAVA_HOME
`String`	`getJvmTarget()` Target version of the generated JVM bytecode (1.6 or 1.8), default is 1.6 Possible values: "1.6", "1.8"
`com.google.common.collect.ImmutableMap<String,String>`	`getKaptApOptions()`
`com.google.common.collect.ImmutableList<SourcePath>`	`getKotlincPlugins()`
`com.google.common.collect.ImmutableSortedSet<String>`	`getLabels()`
`Optional<String>`	`getLanguageVersion()` Provide source compatibility with specified language version.
`com.google.common.collect.ImmutableSet<SourcePath>`	`getLicenses()`
`Optional<SourcePath>`	`getManifestFile()`
`Optional<String>`	`getMavenCoords()`
`Optional<SourcePath>`	`getMavenPomTemplate()`
`String`	`getName()` Each rule has a name
`Optional<Boolean>`	`getNeverMarkAsUnusedDependency()`
`boolean`	`getNoJdk()` Don't include Java runtime into classpath.
`boolean`	`getNoReflect()` Don't include kotlin-reflect.jar into classpath.
`boolean`	`getNoStdlib()` Don't include kotlin-stdlib.jar or kotlin-reflect.jar into classpath.
`Optional<JavaBuckConfig.UnusedDependenciesAction>`	`getOnUnusedDependencies()`
`com.google.common.collect.ImmutableList<BuildTarget>`	`getPlugins()`
`com.google.common.collect.ImmutableList<String>`	`getPostprocessClassesCommands()`
`Optional<SourcePath>`	`getProguardConfig()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getProvidedDeps()`
`com.google.common.collect.ImmutableSet<Pattern>`	`getRemoveClasses()`
`boolean`	`getRequiredForSourceOnlyAbi()`
`com.google.common.collect.ImmutableSortedSet<SourcePath>`	`getResources()`
`Optional<Path>`	`getResourcesRoot()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getRuntimeDeps()`
`Optional<String>`	`getSource()`
`Optional<JavaBuckConfig.SourceAbiVerificationMode>`	`getSourceAbiVerificationMode()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getSourceOnlyAbiDeps()`
`com.google.common.collect.ImmutableSortedSet<SourcePath>`	`getSrcs()`
`boolean`	`getSuppressWarnings()` Generate no warnings.
`Optional<String>`	`getTarget()`
`com.google.common.collect.ImmutableSortedSet<BuildTarget>`	`getTests()`
`Optional<SourcePath>`	`getUnbundledResourcesRoot()`
`boolean`	`getVerbose()` Enable verbose logging output.
`int`	`hashCode()` Computes a hash code from attributes: `freeCompilerArgs`, `allWarningsAsErrors`, `suppressWarnings`, `verbose`, `includeRuntime`, `jvmTarget`, `jdkHome`, `noJdk`, `noStdlib`, `noReflect`, `javaParameters`, `apiVersion`, `languageVersion`, `annotationProcessingTool`, `friendPaths`, `kaptApOptions`, `kotlincPlugins`, `resources`, `proguardConfig`, `postprocessClassesCommands`, `resourcesRoot`, `unbundledResourcesRoot`, `manifestFile`, `mavenCoords`, `mavenPomTemplate`, `exportedDeps`, `sourceOnlyAbiDeps`, `runtimeDeps`, `source`, `target`, `javaVersion`, `javac`, `javacJar`, `compilerClassName`, `compiler`, `extraArguments`, `removeClasses`, `annotationProcessorDeps`, `annotationProcessorParams`, `javaPluginParams`, `annotationProcessors`, `annotationProcessorOnly`, `plugins`, `abiGenerationMode`, `compileAgainst`, `sourceAbiVerificationMode`, `onUnusedDependencies`, `neverMarkAsUnusedDependency`, `licenses`, `labels`, `defaultTargetPlatform`, `compatibleWith`, `name`, `requiredForSourceOnlyAbi`, `deps`, `providedDeps`, `exportedProvidedDeps`, `srcs`, `tests`.
`String`	`toString()` Prints the immutable value `KotlinLibraryDescriptionArg` 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.jvm.java.JvmLibraryArg
addLegacyProcessors, addPlugins, buildJavaAnnotationProcessorParams, buildStandardJavacParams, getJavacSpec, getPluginsOf, hasJavacSpec, isValidJavacJar, verify

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

- Method Detail
  - getFreeCompilerArgs
```
public com.google.common.collect.ImmutableList<String> getFreeCompilerArgs()
```
    A list of additional compiler arguments.
  - getAllWarningsAsErrors
```
public boolean getAllWarningsAsErrors()
```
    Report an error if there are any warnings.
  - getSuppressWarnings
```
public boolean getSuppressWarnings()
```
    Generate no warnings.
  - getVerbose
```
public boolean getVerbose()
```
    Enable verbose logging output.
  - getIncludeRuntime
```
public boolean getIncludeRuntime()
```
    Include Kotlin runtime in to resulting .jar
  - getJvmTarget
```
public String getJvmTarget()
```
    Target version of the generated JVM bytecode (1.6 or 1.8), default is 1.6 Possible values: "1.6", "1.8"
  - getJdkHome
```
public Optional<String> getJdkHome()
```
    Path to JDK home directory to include into classpath, if differs from default JAVA_HOME
  - getNoJdk
```
public boolean getNoJdk()
```
    Don't include Java runtime into classpath.
  - getNoStdlib
```
public boolean getNoStdlib()
```
    Don't include kotlin-stdlib.jar or kotlin-reflect.jar into classpath.
  - getNoReflect
```
public boolean getNoReflect()
```
    Don't include kotlin-reflect.jar into classpath.
  - getJavaParameters
```
public boolean getJavaParameters()
```
    Generate metadata for Java 1.8 reflection on method parameters.
  - getApiVersion
```
public Optional<String> getApiVersion()
```
    Allow to use declarations only from the specified version of bundled libraries. Possible values: "1.0", "1.1", "1.2", "1.3", "1.4".
  - getLanguageVersion
```
public Optional<String> getLanguageVersion()
```
    Provide source compatibility with specified language version. Possible values: "1.0", "1.1", "1.2", "1.3", "1.4".
  - getAnnotationProcessingTool
```
public Optional<KotlinLibraryDescription.AnnotationProcessingTool> getAnnotationProcessingTool()
```
    Returns:
    
    The value of the annotationProcessingTool attribute
  - getFriendPaths
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getFriendPaths()
```
    Returns:
    
    The value of the friendPaths attribute
  - getKaptApOptions
```
public com.google.common.collect.ImmutableMap<String,String> getKaptApOptions()
```
    Returns:
    
    The value of the kaptApOptions attribute
  - getKotlincPlugins
```
public com.google.common.collect.ImmutableList<SourcePath> getKotlincPlugins()
```
    Returns:
    
    The value of the kotlincPlugins attribute
  - getResources
```
public com.google.common.collect.ImmutableSortedSet<SourcePath> getResources()
```
    Returns:
    
    The value of the resources attribute
  - getProguardConfig
```
public Optional<SourcePath> getProguardConfig()
```
    Returns:
    
    The value of the proguardConfig attribute
  - getPostprocessClassesCommands
```
public com.google.common.collect.ImmutableList<String> getPostprocessClassesCommands()
```
    Returns:
    
    The value of the postprocessClassesCommands attribute
  - getResourcesRoot
```
public Optional<Path> getResourcesRoot()
```
    Returns:
    
    The value of the resourcesRoot attribute
  - getUnbundledResourcesRoot
```
public Optional<SourcePath> getUnbundledResourcesRoot()
```
    Returns:
    
    The value of the unbundledResourcesRoot attribute
  - getManifestFile
```
public Optional<SourcePath> getManifestFile()
```
    Returns:
    
    The value of the manifestFile attribute
  - getMavenCoords
```
public Optional<String> getMavenCoords()
```
    Returns:
    
    The value of the mavenCoords attribute
  - getMavenPomTemplate
```
public Optional<SourcePath> getMavenPomTemplate()
```
    Returns:
    
    The value of the mavenPomTemplate attribute
  - getExportedDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getExportedDeps()
```
    Returns:
    
    The value of the exportedDeps attribute
  - getSourceOnlyAbiDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getSourceOnlyAbiDeps()
```
    Returns:
    
    The value of the sourceOnlyAbiDeps attribute
  - getRuntimeDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getRuntimeDeps()
```
    Returns:
    
    The value of the runtimeDeps attribute
  - getSource
```
public Optional<String> getSource()
```
    Returns:
    
    The value of the source attribute
  - getTarget
```
public Optional<String> getTarget()
```
    Returns:
    
    The value of the target attribute
  - getJavaVersion
```
public Optional<String> getJavaVersion()
```
    Returns:
    
    The value of the javaVersion attribute
  - getJavac
```
public Optional<SourcePath> getJavac()
```
    Returns:
    
    The value of the javac attribute
  - getJavacJar
```
public Optional<SourcePath> getJavacJar()
```
    Returns:
    
    The value of the javacJar attribute
  - getCompilerClassName
```
public Optional<String> getCompilerClassName()
```
    Returns:
    
    The value of the compilerClassName attribute
  - getCompiler
```
public Optional<Either<BuiltInJavac,SourcePath>> getCompiler()
```
    Returns:
    
    The value of the compiler attribute
  - getExtraArguments
```
public com.google.common.collect.ImmutableList<String> getExtraArguments()
```
    Returns:
    
    The value of the extraArguments attribute
  - getRemoveClasses
```
public com.google.common.collect.ImmutableSet<Pattern> getRemoveClasses()
```
    Returns:
    
    The value of the removeClasses attribute
  - getAnnotationProcessorDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getAnnotationProcessorDeps()
```
    Returns:
    
    The value of the annotationProcessorDeps attribute
  - getAnnotationProcessorParams
```
public com.google.common.collect.ImmutableList<String> getAnnotationProcessorParams()
```
    Returns:
    
    The value of the annotationProcessorParams attribute
  - getJavaPluginParams
```
public com.google.common.collect.ImmutableList<String> getJavaPluginParams()
```
    Returns:
    
    The value of the javaPluginParams attribute
  - getAnnotationProcessors
```
public com.google.common.collect.ImmutableSet<String> getAnnotationProcessors()
```
    Returns:
    
    The value of the annotationProcessors attribute
  - getAnnotationProcessorOnly
```
public Optional<Boolean> getAnnotationProcessorOnly()
```
    Returns:
    
    The value of the annotationProcessorOnly attribute
  - getPlugins
```
public com.google.common.collect.ImmutableList<BuildTarget> getPlugins()
```
    Returns:
    
    The value of the plugins attribute
  - getAbiGenerationMode
```
public Optional<AbiGenerationMode> getAbiGenerationMode()
```
    Returns:
    
    The value of the abiGenerationMode attribute
  - getCompileAgainst
```
public Optional<CompileAgainstLibraryType> getCompileAgainst()
```
    Returns:
    
    The value of the compileAgainst attribute
  - getSourceAbiVerificationMode
```
public Optional<JavaBuckConfig.SourceAbiVerificationMode> getSourceAbiVerificationMode()
```
    Returns:
    
    The value of the sourceAbiVerificationMode attribute
  - getOnUnusedDependencies
```
public Optional<JavaBuckConfig.UnusedDependenciesAction> getOnUnusedDependencies()
```
    Returns:
    
    The value of the onUnusedDependencies attribute
  - getNeverMarkAsUnusedDependency
```
public Optional<Boolean> getNeverMarkAsUnusedDependency()
```
    Returns:
    
    The value of the neverMarkAsUnusedDependency attribute
  - 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
  - getRequiredForSourceOnlyAbi
```
public boolean getRequiredForSourceOnlyAbi()
```
    Returns:
    
    The value of the requiredForSourceOnlyAbi attribute
  - getDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getDeps()
```
    Returns:
    
    The value of the deps attribute
  - getProvidedDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getProvidedDeps()
```
    Returns:
    
    The value of the providedDeps attribute
  - getExportedProvidedDeps
```
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getExportedProvidedDeps()
```
    Returns:
    
    The value of the exportedProvidedDeps attribute
  - getSrcs
```
public com.google.common.collect.ImmutableSortedSet<SourcePath> getSrcs()
```
    Returns:
    
    The value of the srcs attribute
  - 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 KotlinLibraryDescriptionArg 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: freeCompilerArgs, allWarningsAsErrors, suppressWarnings, verbose, includeRuntime, jvmTarget, jdkHome, noJdk, noStdlib, noReflect, javaParameters, apiVersion, languageVersion, annotationProcessingTool, friendPaths, kaptApOptions, kotlincPlugins, resources, proguardConfig, postprocessClassesCommands, resourcesRoot, unbundledResourcesRoot, manifestFile, mavenCoords, mavenPomTemplate, exportedDeps, sourceOnlyAbiDeps, runtimeDeps, source, target, javaVersion, javac, javacJar, compilerClassName, compiler, extraArguments, removeClasses, annotationProcessorDeps, annotationProcessorParams, javaPluginParams, annotationProcessors, annotationProcessorOnly, plugins, abiGenerationMode, compileAgainst, sourceAbiVerificationMode, onUnusedDependencies, neverMarkAsUnusedDependency, licenses, labels, defaultTargetPlatform, compatibleWith, name, requiredForSourceOnlyAbi, deps, providedDeps, exportedProvidedDeps, srcs, tests.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value KotlinLibraryDescriptionArg with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static KotlinLibraryDescriptionArg.Builder builder()
```
    Creates a builder for KotlinLibraryDescriptionArg.
    
    Returns:
    
    A new KotlinLibraryDescriptionArg builder

Class KotlinLibraryDescriptionArg

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.jvm.java.JvmLibraryArg

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

Method Detail

getFreeCompilerArgs

getAllWarningsAsErrors

getSuppressWarnings

getVerbose

getIncludeRuntime

getJvmTarget

getJdkHome

getNoJdk

getNoStdlib

getNoReflect

getJavaParameters

getApiVersion

getLanguageVersion

getAnnotationProcessingTool

getFriendPaths

getKaptApOptions

getKotlincPlugins

getResources

getProguardConfig

getPostprocessClassesCommands

getResourcesRoot

getUnbundledResourcesRoot

getManifestFile

getMavenCoords

getMavenPomTemplate

getExportedDeps

getSourceOnlyAbiDeps

getRuntimeDeps

getSource

getTarget

getJavaVersion

getJavac

getJavacJar

getCompilerClassName

getCompiler

getExtraArguments

getRemoveClasses

getAnnotationProcessorDeps

getAnnotationProcessorParams

getJavaPluginParams

getAnnotationProcessors

getAnnotationProcessorOnly

getPlugins

getAbiGenerationMode

getCompileAgainst

getSourceAbiVerificationMode

getOnUnusedDependencies

getNeverMarkAsUnusedDependency

getLicenses

getLabels

getDefaultTargetPlatform

getCompatibleWith

getName

getRequiredForSourceOnlyAbi

getDeps

getProvidedDeps

getExportedProvidedDeps

getSrcs

getTests

equals

hashCode

toString

builder