com.apollographql.apollo.gradle.api.CompilationUnit.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-gradle-plugin Show documentation

Gradle plugin for generating java/kotlin classes for graphql files

There is a newer version: 4.1.0

package com.apollographql.apollo.gradle.api

import org.gradle.api.file.Directory
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.Provider

/**
 * A [CompilationUnit] is a single invocation of the compiler. It is used by
 * [com.apollographql.apollo.gradle.internal.ApolloGenerateSourcesTask] to generate models.
 *
 * It inherits [CompilerParams] so individual parameters can be directly set on the [CompilationUnit]
 */
interface CompilationUnit: CompilerParams {
  /**
   * The name of the [CompilationUnit]
   */
  val name: String
  /**
   * The name of the [Service] used by this [CompilationUnit]
   */
  val serviceName: String
  /**
   * The name of the variant used by this [CompilationUnit]
   */
  val variantName: String
  /**
   * If on Android, this will contain the Android Variant. It is safe to cast it to [com.android.build.gradle.api.BaseVariant]
   */
  val androidVariant: Any?

  /**
   * The directory where the generated models will be written
   */
  val outputDir: Provider

  /**
   * The file where the operation output json will be written
   */
  val operationOutputFile: RegularFileProperty
}