apollo-compiler/com.apollographql.apollo3.compiler

Package com.apollographql.apollo3.compiler

Types

AdapterInitializer

@JsonClass(generateAdapter = true, generator = "sealed:type")

interface AdapterInitializer

Controls how scalar adapters are used in the generated code.

ApolloCompiler

@ApolloExperimental

object ApolloCompiler

ApolloMetadata

@JsonClass(generateAdapter = true)

data class ApolloMetadata( val commonMetadata: CommonMetadata?, val compilerMetadata: CompilerMetadata, val moduleName: String)

metadata generated by a previous run of ApolloCompiler. The schema and fragments are stored as GraphQL document strings. This slightly unfortunate because that means we will parse them twice but there isn't many alternatives as validation and IR-building takes GQLDocuments as inputs. A future version could serialize GQLNode as json in order to keep the SourceLocation attributes and display better error messages

CommonMetadata

@JsonClass(generateAdapter = true)

data class CommonMetadata( val schema: Schema, val schemaPackageName: String, val pluginVersion: String, val codegenModels: String, val scalarMapping: Map<String, ScalarInfo>)

Options that must be common to all modules

CompilerMetadata

@JsonClass(generateAdapter = true)

data class CompilerMetadata(val fragments: List<GQLFragmentDefinition>, val resolverInfo: ResolverInfo)

Compilation unit specific metadata that is specific to a given invocation of the compiler

ExpressionAdapterInitializer

@JsonClass(generateAdapter = true)

class ExpressionAdapterInitializer(val expression: String) : AdapterInitializer

The adapter expression will be used as-is (can be an object, a public val, a class instantiation).

IncomingOptions

class IncomingOptions( val schema: Schema, val codegenModels: String, val schemaPackageName: String)

These are the options that should be the same in all modules.

JavaNullable

enum JavaNullable : Enum<JavaNullable>

OperationIdGenerator

interface OperationIdGenerator

OperationOutputGenerator

interface OperationOutputGenerator

A class that generates OperationOutput to compute the operationIds. OperationOutputGenerator works with a collection of OperationDescriptor for implementation that need to batch compute the operationIds. For an example to send all the operation at once to a backend for whitelisting.

Options

@ApolloExperimental

class Options( val executableFiles: Set<File>, val schema: Schema, val outputDir: File, val testDir: File, val debugDir: File? = null, val operationManifestFile: File? = null, val operationManifestFormat: String = MANIFEST_NONE, val schemaPackageName: String, val useSchemaPackageNameForFragments: Boolean = defaultUseSchemaPackageNameForFragments, val packageNameGenerator: PackageNameGenerator, val alwaysGenerateTypesMatching: Set<String> = defaultAlwaysGenerateTypesMatching, val operationOutputGenerator: OperationOutputGenerator = defaultOperationOutputGenerator, val incomingCompilerMetadata: List<CompilerMetadata> = emptyList(), val targetLanguage: TargetLanguage = defaultTargetLanguage, val scalarMapping: Map<String, ScalarInfo> = defaultScalarMapping, val codegenModels: String = defaultCodegenModels, val flattenModels: Boolean = defaultFlattenModels, val useSemanticNaming: Boolean = defaultUseSemanticNaming, val warnOnDeprecatedUsages: Boolean = defaultWarnOnDeprecatedUsages, val failOnWarnings: Boolean = defaultFailOnWarnings, val logger: ApolloCompiler.Logger = defaultLogger, val generateAsInternal: Boolean = defaultGenerateAsInternal, val generateFilterNotNull: Boolean = defaultGenerateFilterNotNull, val generateFragmentImplementations: Boolean = defaultGenerateFragmentImplementations, val generateResponseFields: Boolean = defaultGenerateResponseFields, val generateQueryDocument: Boolean = defaultGenerateQueryDocument, val generateSchema: Boolean = defaultGenerateSchema, val generatedSchemaName: String = defaultGeneratedSchemaName, val generateTestBuilders: Boolean = defaultGenerateTestBuilders, val generateDataBuilders: Boolean = defaultGenerateDataBuilders, val generateModelBuilders: Boolean = defaultGenerateModelBuilders, val sealedClassesForEnumsMatching: List<String> = defaultSealedClassesForEnumsMatching, val classesForEnumsMatching: List<String> = defaultClassesForEnumsMatching, val generateOptionalOperationVariables: Boolean = defaultGenerateOptionalOperationVariables, val addJvmOverloads: Boolean = false, val addTypename: String = defaultAddTypename, val requiresOptInAnnotation: String? = defaultRequiresOptInAnnotation, val fieldsOnDisjointTypesMustMerge: Boolean = defaultFieldsOnDisjointTypesMustMerge, val generatePrimitiveTypes: Boolean = defaultGeneratePrimitiveTypes, val nullableFieldStyle: JavaNullable = defaultNullableFieldStyle, val decapitalizeFields: Boolean = defaultDecapitalizeFields, val compilerKotlinHooks: ApolloCompilerKotlinHooks = defaultCompilerKotlinHooks, val compilerJavaHooks: ApolloCompilerJavaHooks = defaultCompilerJavaHooks)

PackageNameGenerator

interface PackageNameGenerator

A PackageNameGenerator computes the package name for a given file. Files can be either

Roots