Package com.facebook.buck.jvm.kotlin
Class KotlinLibraryDescriptionArg
- java.lang.Object
-
- com.facebook.buck.jvm.kotlin.KotlinLibraryDescriptionArg
-
- All Implemented Interfaces:
BuildRuleArg
,ConstructorArg
,DataTransferObject
,HasDeclaredDeps
,HasProvidedDeps
,HasSrcs
,HasTests
,JavaLibraryDescription.CoreArg
,JvmLibraryArg
,MaybeRequiredForSourceOnlyAbiArg
,KotlinLibraryDescription.CoreArg
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class KotlinLibraryDescriptionArg extends Object
Immutable implementation ofKotlinLibraryDescription.AbstractKotlinLibraryDescriptionArg
.Use the builder to create immutable instances:
KotlinLibraryDescriptionArg.builder()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KotlinLibraryDescriptionArg.Builder
Builds instances of typeKotlinLibraryDescriptionArg
.
-
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 KotlinLibraryDescriptionArg.Builder
builder()
Creates a builder forKotlinLibraryDescriptionArg
.boolean
equals(Object another)
This instance is equal to all instances ofKotlinLibraryDescriptionArg
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 ofconfig_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 .jarOptional<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_HOMEString
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 nameOptional<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 valueKotlinLibraryDescriptionArg
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
-
Methods inherited from interface com.facebook.buck.jvm.java.JvmLibraryArg
addLegacyProcessors, addPlugins, buildJavaAnnotationProcessorParams, buildStandardJavacParams, getJavacSpec, getPluginsOf, hasJavacSpec, isValidJavacJar, verify
-
-
-
-
Method Detail
-
getFreeCompilerArgs
public com.google.common.collect.ImmutableList<String> getFreeCompilerArgs()
A list of additional compiler arguments.- Specified by:
getFreeCompilerArgs
in interfaceKotlinLibraryDescription.CoreArg
-
getAllWarningsAsErrors
public boolean getAllWarningsAsErrors()
Report an error if there are any warnings.- Specified by:
getAllWarningsAsErrors
in interfaceKotlinLibraryDescription.CoreArg
-
getSuppressWarnings
public boolean getSuppressWarnings()
Generate no warnings.- Specified by:
getSuppressWarnings
in interfaceKotlinLibraryDescription.CoreArg
-
getVerbose
public boolean getVerbose()
Enable verbose logging output.- Specified by:
getVerbose
in interfaceKotlinLibraryDescription.CoreArg
-
getIncludeRuntime
public boolean getIncludeRuntime()
Include Kotlin runtime in to resulting .jar- Specified by:
getIncludeRuntime
in interfaceKotlinLibraryDescription.CoreArg
-
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"- Specified by:
getJvmTarget
in interfaceKotlinLibraryDescription.CoreArg
-
getJdkHome
public Optional<String> getJdkHome()
Path to JDK home directory to include into classpath, if differs from default JAVA_HOME- Specified by:
getJdkHome
in interfaceKotlinLibraryDescription.CoreArg
-
getNoJdk
public boolean getNoJdk()
Don't include Java runtime into classpath.- Specified by:
getNoJdk
in interfaceKotlinLibraryDescription.CoreArg
-
getNoStdlib
public boolean getNoStdlib()
Don't include kotlin-stdlib.jar or kotlin-reflect.jar into classpath.- Specified by:
getNoStdlib
in interfaceKotlinLibraryDescription.CoreArg
-
getNoReflect
public boolean getNoReflect()
Don't include kotlin-reflect.jar into classpath.- Specified by:
getNoReflect
in interfaceKotlinLibraryDescription.CoreArg
-
getJavaParameters
public boolean getJavaParameters()
Generate metadata for Java 1.8 reflection on method parameters.- Specified by:
getJavaParameters
in interfaceKotlinLibraryDescription.CoreArg
-
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".- Specified by:
getApiVersion
in interfaceKotlinLibraryDescription.CoreArg
-
getLanguageVersion
public Optional<String> getLanguageVersion()
Provide source compatibility with specified language version. Possible values: "1.0", "1.1", "1.2", "1.3", "1.4".- Specified by:
getLanguageVersion
in interfaceKotlinLibraryDescription.CoreArg
-
getAnnotationProcessingTool
public Optional<KotlinLibraryDescription.AnnotationProcessingTool> getAnnotationProcessingTool()
- Specified by:
getAnnotationProcessingTool
in interfaceKotlinLibraryDescription.CoreArg
- Returns:
- The value of the
annotationProcessingTool
attribute
-
getFriendPaths
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getFriendPaths()
- Specified by:
getFriendPaths
in interfaceKotlinLibraryDescription.CoreArg
- Returns:
- The value of the
friendPaths
attribute
-
getKaptApOptions
public com.google.common.collect.ImmutableMap<String,String> getKaptApOptions()
- Specified by:
getKaptApOptions
in interfaceKotlinLibraryDescription.CoreArg
- Returns:
- The value of the
kaptApOptions
attribute
-
getKotlincPlugins
public com.google.common.collect.ImmutableList<SourcePath> getKotlincPlugins()
- Specified by:
getKotlincPlugins
in interfaceKotlinLibraryDescription.CoreArg
- Returns:
- The value of the
kotlincPlugins
attribute
-
getResources
public com.google.common.collect.ImmutableSortedSet<SourcePath> getResources()
- Specified by:
getResources
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
resources
attribute
-
getProguardConfig
public Optional<SourcePath> getProguardConfig()
- Specified by:
getProguardConfig
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
proguardConfig
attribute
-
getPostprocessClassesCommands
public com.google.common.collect.ImmutableList<String> getPostprocessClassesCommands()
- Specified by:
getPostprocessClassesCommands
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
postprocessClassesCommands
attribute
-
getResourcesRoot
public Optional<Path> getResourcesRoot()
- Specified by:
getResourcesRoot
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
resourcesRoot
attribute
-
getUnbundledResourcesRoot
public Optional<SourcePath> getUnbundledResourcesRoot()
- Specified by:
getUnbundledResourcesRoot
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
unbundledResourcesRoot
attribute
-
getManifestFile
public Optional<SourcePath> getManifestFile()
- Specified by:
getManifestFile
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
manifestFile
attribute
-
getMavenCoords
public Optional<String> getMavenCoords()
- Specified by:
getMavenCoords
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
mavenCoords
attribute
-
getMavenPomTemplate
public Optional<SourcePath> getMavenPomTemplate()
- Specified by:
getMavenPomTemplate
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
mavenPomTemplate
attribute
-
getExportedDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getExportedDeps()
- Specified by:
getExportedDeps
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
exportedDeps
attribute
-
getSourceOnlyAbiDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getSourceOnlyAbiDeps()
- Specified by:
getSourceOnlyAbiDeps
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
sourceOnlyAbiDeps
attribute
-
getRuntimeDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getRuntimeDeps()
- Specified by:
getRuntimeDeps
in interfaceJavaLibraryDescription.CoreArg
- Returns:
- The value of the
runtimeDeps
attribute
-
getSource
public Optional<String> getSource()
- Specified by:
getSource
in interfaceJvmLibraryArg
- Returns:
- The value of the
source
attribute
-
getTarget
public Optional<String> getTarget()
- Specified by:
getTarget
in interfaceJvmLibraryArg
- Returns:
- The value of the
target
attribute
-
getJavaVersion
public Optional<String> getJavaVersion()
- Specified by:
getJavaVersion
in interfaceJvmLibraryArg
- Returns:
- The value of the
javaVersion
attribute
-
getJavac
public Optional<SourcePath> getJavac()
- Specified by:
getJavac
in interfaceJvmLibraryArg
- Returns:
- The value of the
javac
attribute
-
getJavacJar
public Optional<SourcePath> getJavacJar()
- Specified by:
getJavacJar
in interfaceJvmLibraryArg
- Returns:
- The value of the
javacJar
attribute
-
getCompilerClassName
public Optional<String> getCompilerClassName()
- Specified by:
getCompilerClassName
in interfaceJvmLibraryArg
- Returns:
- The value of the
compilerClassName
attribute
-
getCompiler
public Optional<Either<BuiltInJavac,SourcePath>> getCompiler()
- Specified by:
getCompiler
in interfaceJvmLibraryArg
- Returns:
- The value of the
compiler
attribute
-
getExtraArguments
public com.google.common.collect.ImmutableList<String> getExtraArguments()
- Specified by:
getExtraArguments
in interfaceJvmLibraryArg
- Returns:
- The value of the
extraArguments
attribute
-
getRemoveClasses
public com.google.common.collect.ImmutableSet<Pattern> getRemoveClasses()
- Specified by:
getRemoveClasses
in interfaceJvmLibraryArg
- Returns:
- The value of the
removeClasses
attribute
-
getAnnotationProcessorDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getAnnotationProcessorDeps()
- Specified by:
getAnnotationProcessorDeps
in interfaceJvmLibraryArg
- Returns:
- The value of the
annotationProcessorDeps
attribute
-
getAnnotationProcessorParams
public com.google.common.collect.ImmutableList<String> getAnnotationProcessorParams()
- Specified by:
getAnnotationProcessorParams
in interfaceJvmLibraryArg
- Returns:
- The value of the
annotationProcessorParams
attribute
-
getJavaPluginParams
public com.google.common.collect.ImmutableList<String> getJavaPluginParams()
- Specified by:
getJavaPluginParams
in interfaceJvmLibraryArg
- Returns:
- The value of the
javaPluginParams
attribute
-
getAnnotationProcessors
public com.google.common.collect.ImmutableSet<String> getAnnotationProcessors()
- Specified by:
getAnnotationProcessors
in interfaceJvmLibraryArg
- Returns:
- The value of the
annotationProcessors
attribute
-
getAnnotationProcessorOnly
public Optional<Boolean> getAnnotationProcessorOnly()
- Specified by:
getAnnotationProcessorOnly
in interfaceJvmLibraryArg
- Returns:
- The value of the
annotationProcessorOnly
attribute
-
getPlugins
public com.google.common.collect.ImmutableList<BuildTarget> getPlugins()
- Specified by:
getPlugins
in interfaceJvmLibraryArg
- Returns:
- The value of the
plugins
attribute
-
getAbiGenerationMode
public Optional<AbiGenerationMode> getAbiGenerationMode()
- Specified by:
getAbiGenerationMode
in interfaceJvmLibraryArg
- Returns:
- The value of the
abiGenerationMode
attribute
-
getCompileAgainst
public Optional<CompileAgainstLibraryType> getCompileAgainst()
- Specified by:
getCompileAgainst
in interfaceJvmLibraryArg
- Returns:
- The value of the
compileAgainst
attribute
-
getSourceAbiVerificationMode
public Optional<JavaBuckConfig.SourceAbiVerificationMode> getSourceAbiVerificationMode()
- Specified by:
getSourceAbiVerificationMode
in interfaceJvmLibraryArg
- Returns:
- The value of the
sourceAbiVerificationMode
attribute
-
getOnUnusedDependencies
public Optional<JavaBuckConfig.UnusedDependenciesAction> getOnUnusedDependencies()
- Specified by:
getOnUnusedDependencies
in interfaceJvmLibraryArg
- Returns:
- The value of the
onUnusedDependencies
attribute
-
getNeverMarkAsUnusedDependency
public Optional<Boolean> getNeverMarkAsUnusedDependency()
- Specified by:
getNeverMarkAsUnusedDependency
in interfaceJvmLibraryArg
- Returns:
- The value of the
neverMarkAsUnusedDependency
attribute
-
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
-
getRequiredForSourceOnlyAbi
public boolean getRequiredForSourceOnlyAbi()
- Specified by:
getRequiredForSourceOnlyAbi
in interfaceMaybeRequiredForSourceOnlyAbiArg
- Returns:
- The value of the
requiredForSourceOnlyAbi
attribute
-
getDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getDeps()
- Specified by:
getDeps
in interfaceHasDeclaredDeps
- Returns:
- The value of the
deps
attribute
-
getProvidedDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getProvidedDeps()
- Specified by:
getProvidedDeps
in interfaceHasProvidedDeps
- Returns:
- The value of the
providedDeps
attribute
-
getExportedProvidedDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getExportedProvidedDeps()
- Specified by:
getExportedProvidedDeps
in interfaceHasProvidedDeps
- Returns:
- The value of the
exportedProvidedDeps
attribute
-
getSrcs
public com.google.common.collect.ImmutableSortedSet<SourcePath> getSrcs()
-
getTests
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()
-
equals
public boolean equals(@Nullable Object another)
This instance is equal to all instances ofKotlinLibraryDescriptionArg
that have equal attribute values.
-
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
.
-
toString
public String toString()
Prints the immutable valueKotlinLibraryDescriptionArg
with attribute values.
-
builder
public static KotlinLibraryDescriptionArg.Builder builder()
Creates a builder forKotlinLibraryDescriptionArg
.- Returns:
- A new KotlinLibraryDescriptionArg builder
-
-