Package graphql.schema.idl

Class ImmutableTypeDefinitionRegistry

java.lang.Object

graphql.schema.idl.TypeDefinitionRegistry

graphql.schema.idl.ImmutableTypeDefinitionRegistry

All Implemented Interfaces:

Serializable

@PublicApi
@NullMarked
public class ImmutableTypeDefinitionRegistry
extends TypeDefinitionRegistry

A ImmutableTypeDefinitionRegistry contains an immutable set of type definitions that come from compiling a graphql schema definition file via SchemaParser.parse(String) and is more performant because it uses ImmutableMap structures.

See Also:

• Serialized Form

Field Summary

Fields inherited from class graphql.schema.idl.TypeDefinitionRegistry

directiveDefinitions, enumTypeExtensions, inputObjectTypeExtensions, interfaceTypeExtensions, objectTypeExtensions, scalarTypeExtensions, scalarTypes, schema, schemaExtensionDefinitions, schemaParseOrder, types, unionTypeExtensions

Method Summary

Modifier and Type	Method	Description
Optional<GraphQLError>	add(SDLDefinition definition)	Adds a definition to the registry
Optional<GraphQLError>	addAll(Collection<SDLDefinition> definitions)	Adds a a collections of definitions to the registry
Map<String,List<EnumTypeExtensionDefinition>>	enumTypeExtensions()
Map<String,DirectiveDefinition>	getDirectiveDefinitions()
List<SchemaExtensionDefinition>	getSchemaExtensionDefinitions()
Map<String,List<InputObjectTypeExtensionDefinition>>	inputObjectTypeExtensions()
Map<String,List<InterfaceTypeExtensionDefinition>>	interfaceTypeExtensions()
TypeDefinitionRegistry	merge(TypeDefinitionRegistry typeRegistry)	This will merge these type registries together and return this one
Map<String,List<ObjectTypeExtensionDefinition>>	objectTypeExtensions()
void	remove(SDLDefinition definition)	Removes a SDLDefinition from the definition list.
void	remove(String key, SDLDefinition definition)	Removes a SDLDefinition from a map.
Map<String,ScalarTypeDefinition>	scalars()
Map<String,List<ScalarTypeExtensionDefinition>>	scalarTypeExtensions()
Map<String,TypeDefinition>	types()
Map<String,List<UnionTypeExtensionDefinition>>	unionTypeExtensions()

Methods inherited from class graphql.schema.idl.TypeDefinitionRegistry

getAllImplementationsOf, getDirectiveDefinition, getImplementationsOf, getParseOrder, getType, getType, getType, getType, getTypes, getTypesMap, hasType, isInterfaceOrUnion, isObjectType, isObjectTypeOrInterface, isPossibleType, isSubTypeOf, readOnly, schemaDefinition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

merge

public TypeDefinitionRegistry merge(TypeDefinitionRegistry typeRegistry)
                             throws SchemaProblem

Description copied from class: TypeDefinitionRegistry

This will merge these type registries together and return this one

Overrides:

merge in class TypeDefinitionRegistry

Parameters:

typeRegistry - the registry to be merged into this one

Returns:

this registry

Throws:

SchemaProblem - if there are problems merging the types such as redefinitions

addAll

public Optional<GraphQLError> addAll(Collection<SDLDefinition> definitions)

Description copied from class: TypeDefinitionRegistry

Adds a a collections of definitions to the registry

Overrides:

addAll in class TypeDefinitionRegistry

Parameters:

definitions - the definitions to add

Returns:

an optional error for the first problem, typically type redefinition

add

public Optional<GraphQLError> add(SDLDefinition definition)

Description copied from class: TypeDefinitionRegistry

Adds a definition to the registry

Overrides:

add in class TypeDefinitionRegistry

Parameters:

definition - the definition to add

Returns:

an optional error

remove

public void remove(SDLDefinition definition)

Description copied from class: TypeDefinitionRegistry

Removes a SDLDefinition from the definition list.

Overrides:

remove in class TypeDefinitionRegistry

Parameters:

definition - the definition to remove

remove

public void remove(String key,
 SDLDefinition definition)

Description copied from class: TypeDefinitionRegistry

Removes a SDLDefinition from a map.

Overrides:

remove in class TypeDefinitionRegistry

Parameters:

key - the key to remove

definition - the definition to remove

types

public Map<String,TypeDefinition> types()

Overrides:

types in class TypeDefinitionRegistry

scalars

public Map<String,ScalarTypeDefinition> scalars()

Overrides:

scalars in class TypeDefinitionRegistry

objectTypeExtensions

public Map<String,List<ObjectTypeExtensionDefinition>> objectTypeExtensions()

Overrides:

objectTypeExtensions in class TypeDefinitionRegistry

interfaceTypeExtensions

public Map<String,List<InterfaceTypeExtensionDefinition>> interfaceTypeExtensions()

Overrides:

interfaceTypeExtensions in class TypeDefinitionRegistry

unionTypeExtensions

public Map<String,List<UnionTypeExtensionDefinition>> unionTypeExtensions()

Overrides:

unionTypeExtensions in class TypeDefinitionRegistry

enumTypeExtensions

public Map<String,List<EnumTypeExtensionDefinition>> enumTypeExtensions()

Overrides:

enumTypeExtensions in class TypeDefinitionRegistry

scalarTypeExtensions

public Map<String,List<ScalarTypeExtensionDefinition>> scalarTypeExtensions()

Overrides:

scalarTypeExtensions in class TypeDefinitionRegistry

inputObjectTypeExtensions

public Map<String,List<InputObjectTypeExtensionDefinition>> inputObjectTypeExtensions()

Overrides:

inputObjectTypeExtensions in class TypeDefinitionRegistry

getSchemaExtensionDefinitions

public List<SchemaExtensionDefinition> getSchemaExtensionDefinitions()

Overrides:

getSchemaExtensionDefinitions in class TypeDefinitionRegistry

getDirectiveDefinitions

public Map<String,DirectiveDefinition> getDirectiveDefinitions()

Overrides:

getDirectiveDefinitions in class TypeDefinitionRegistry