Package com.apollographql.apollo3.ast

Types

ConversionException

class ConversionException(error: String, sourceLocation: SourceLocation) : SourceAwareException

An exception while converting to/from introspectionThis most likely means the json/sdl was inconsistent or corrupted

GQLArgument

data class GQLArgument(sourceLocation: SourceLocation, name: String, value: GQLValue) : GQLNode

GQLArguments

data class GQLArguments(arguments: List<GQLArgument>, sourceLocation: SourceLocation) : GQLNode

GQLBooleanValue

data class GQLBooleanValue(sourceLocation: SourceLocation, value: Boolean) : GQLValue

GQLDefinition

interface GQLDefinition : GQLNode

GQLDescribed

interface GQLDescribed

A GQLNode that has a description

GQLDirective

data class GQLDirective(sourceLocation: SourceLocation, name: String, arguments: GQLArguments?) : GQLNode, GQLNamed

GQLDirectiveDefinition

data class GQLDirectiveDefinition(sourceLocation: SourceLocation, description: String?, name: String, arguments: List<GQLInputValueDefinition>, repeatable: Boolean, locations: List<GQLDirectiveLocation>) : GQLDefinition, GQLNamed

GQLDirectiveLocation

enum GQLDirectiveLocation : Enum<GQLDirectiveLocation>

GQLDocument

data class GQLDocument(definitions: List<GQLDefinition>, filePath: String?) : GQLNode

The top level node in a GraphQL document.

GQLEnumTypeDefinition

data class GQLEnumTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>, enumValues: List<GQLEnumValueDefinition>) : GQLTypeDefinition

GQLEnumTypeExtension

data class GQLEnumTypeExtension(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>, enumValues: List<GQLEnumValueDefinition>) : GQLDefinition, GQLTypeExtension

GQLEnumValue

data class GQLEnumValue(sourceLocation: SourceLocation, value: String) : GQLValue

GQLEnumValueDefinition

data class GQLEnumValueDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>) : GQLNode, GQLNamed

GQLField

data class GQLField(sourceLocation: SourceLocation, alias: String?, name: String, arguments: GQLArguments?, directives: List<GQLDirective>, selectionSet: GQLSelectionSet?) : GQLSelection

GQLFieldDefinition

data class GQLFieldDefinition(sourceLocation: SourceLocation, description: String?, name: String, arguments: List<GQLInputValueDefinition>, type: GQLType, directives: List<GQLDirective>) : GQLNode, GQLNamed

GQLFloatValue

data class GQLFloatValue(sourceLocation: SourceLocation, value: Double) : GQLValue

GQLFragmentDefinition

data class GQLFragmentDefinition(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>, typeCondition: GQLNamedType, selectionSet: GQLSelectionSet, description: String?) : GQLDefinition, GQLNamed, GQLDescribed

GQLFragmentSpread

data class GQLFragmentSpread(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>) : GQLSelection

GQLInlineFragment

data class GQLInlineFragment(sourceLocation: SourceLocation, typeCondition: GQLNamedType, directives: List<GQLDirective>, selectionSet: GQLSelectionSet) : GQLSelection

GQLInputObjectTypeDefinition

data class GQLInputObjectTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>, inputFields: List<GQLInputValueDefinition>) : GQLTypeDefinition

GQLInputObjectTypeExtension

data class GQLInputObjectTypeExtension(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>, inputFields: List<GQLInputValueDefinition>) : GQLDefinition, GQLTypeExtension

GQLInputValueDefinition

data class GQLInputValueDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>, type: GQLType, defaultValue: GQLValue?) : GQLNode, GQLNamed

GQLInterfaceTypeDefinition

data class GQLInterfaceTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, implementsInterfaces: List<String>, directives: List<GQLDirective>, fields: List<GQLFieldDefinition>) : GQLTypeDefinition

GQLInterfaceTypeExtension

data class GQLInterfaceTypeExtension(sourceLocation: SourceLocation, name: String, implementsInterfaces: List<String>, fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension, GQLNamed

GQLIntValue

data class GQLIntValue(sourceLocation: SourceLocation, value: Int) : GQLValue

GQLListType

data class GQLListType(sourceLocation: SourceLocation, type: GQLType) : GQLType

GQLListValue

data class GQLListValue(sourceLocation: SourceLocation, values: List<GQLValue>) : GQLValue

GQLNamed

interface GQLNamed

A GQLNode that has a name

GQLNamedType

data class GQLNamedType(sourceLocation: SourceLocation, name: String) : GQLType, GQLNamed

GQLNode

interface GQLNode

A node in the GraphQL AST.

GQLNonNullType

data class GQLNonNullType(sourceLocation: SourceLocation, type: GQLType) : GQLType

GQLNullValue

data class GQLNullValue(sourceLocation: SourceLocation) : GQLValue

GQLObjectField

data class GQLObjectField(sourceLocation: SourceLocation, name: String, value: GQLValue) : GQLNode

GQLObjectTypeDefinition

data class GQLObjectTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, implementsInterfaces: List<String>, directives: List<GQLDirective>, fields: List<GQLFieldDefinition>) : GQLTypeDefinition

GQLObjectTypeExtension

data class GQLObjectTypeExtension(sourceLocation: SourceLocation, name: String, implementsInterfaces: List<String>, directives: List<GQLDirective>, fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension

GQLObjectValue

data class GQLObjectValue(sourceLocation: SourceLocation, fields: List<GQLObjectField>) : GQLValue

GQLOperationDefinition

data class GQLOperationDefinition(sourceLocation: SourceLocation, operationType: String, name: String?, variableDefinitions: List<GQLVariableDefinition>, directives: List<GQLDirective>, selectionSet: GQLSelectionSet, description: String?) : GQLDefinition, GQLDescribed

GQLOperationTypeDefinition

data class GQLOperationTypeDefinition(sourceLocation: SourceLocation, operationType: String, namedType: String) : GQLNode

GQLResult

class GQLResult<out V : Any>(value: V?, issues: List<Issue>)

The result of a parsing or validation operation.

GQLScalarTypeDefinition

data class GQLScalarTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>) : GQLTypeDefinition

GQLScalarTypeExtension

data class GQLScalarTypeExtension(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>) : GQLDefinition, GQLTypeExtension

GQLSchemaDefinition

data class GQLSchemaDefinition(sourceLocation: SourceLocation, description: String?, directives: List<GQLDirective>, rootOperationTypeDefinitions: List<GQLOperationTypeDefinition>) : GQLDefinition

GQLSchemaExtension

data class GQLSchemaExtension(sourceLocation: SourceLocation, directives: List<GQLDirective>, operationTypesDefinition: List<GQLOperationTypeDefinition>) : GQLDefinition, GQLTypeSystemExtension

GQLSelection

sealed class GQLSelection : GQLNode

GQLSelectionSet

data class GQLSelectionSet(selections: List<GQLSelection>, sourceLocation: SourceLocation) : GQLNode

GQLStringValue

data class GQLStringValue(sourceLocation: SourceLocation, value: String) : GQLValue

GQLType

sealed class GQLType : GQLNode

GQLTypeDefinition

sealed class GQLTypeDefinition : GQLDefinition, GQLNamed, GQLDescribed

GQLTypeExtension

interface GQLTypeExtension : GQLTypeSystemExtension, GQLNamed

GQLTypeSystemExtension

interface GQLTypeSystemExtension : GQLNode

GQLUnionTypeDefinition

data class GQLUnionTypeDefinition(sourceLocation: SourceLocation, description: String?, name: String, directives: List<GQLDirective>, memberTypes: List<GQLNamedType>) : GQLTypeDefinition

GQLUnionTypeExtension

data class GQLUnionTypeExtension(sourceLocation: SourceLocation, name: String, directives: List<GQLDirective>, memberTypes: List<GQLNamedType>) : GQLDefinition, GQLTypeExtension

GQLValue

sealed class GQLValue : GQLNode

GQLVariableDefinition

data class GQLVariableDefinition(sourceLocation: SourceLocation, name: String, type: GQLType, defaultValue: GQLValue?, directives: List<GQLDirective>) : GQLNode

A variable definition is very similar to an InputValue definition except it doesn't have a description

GQLVariableValue

data class GQLVariableValue(sourceLocation: SourceLocation, name: String) : GQLValue

Issue

sealed class Issue

All the issues that can be collected while analyzing a graphql document

NodeContainer

class NodeContainer(nodes: List<GQLNode>)

NodeTransformer

fun fun interface NodeTransformer

Schema

class Schema(definitions: List<GQLDefinition>)

A wrapper around a schema GQLDocument that:

always contain builtin types contrary to introspection that will not contain directives and SDL that will not contain any builtin definitions
always has a schema definition
has type extensions merged
has some helper functions to retrieve a type by name and/or possible types

SchemaValidationException

class SchemaValidationException(error: String, sourceLocation: SourceLocation) : SourceAwareException

The schema is invalidTODO: transform this into issues

SDLWriter

open class SDLWriter(sink: BufferedSink, indent: String) : Closeable

A SDLWriter writes utf8 text to the given sink and supports indent/unindent

SourceAwareException

open class SourceAwareException(error: String, sourceLocation: SourceLocation) : RuntimeException

SourceLocation

class SourceLocation(line: Int, position: Int, filePath: String?)

TransformResult

interface TransformResult