Package graphql.schema.idl

Class TypeDefinitionRegistry

java.lang.Object

graphql.schema.idl.TypeDefinitionRegistry

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ImmutableTypeDefinitionRegistry

@PublicApi
@NullMarked
public class TypeDefinitionRegistry
extends Object
implements Serializable

A TypeDefinitionRegistry contains the set of type definitions that come from compiling a graphql schema definition file via SchemaParser.parse(String)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,DirectiveDefinition>	directiveDefinitions
protected final Map<String,List<EnumTypeExtensionDefinition>>	enumTypeExtensions
protected final Map<String,List<InputObjectTypeExtensionDefinition>>	inputObjectTypeExtensions
protected final Map<String,List<InterfaceTypeExtensionDefinition>>	interfaceTypeExtensions
protected final Map<String,List<ObjectTypeExtensionDefinition>>	objectTypeExtensions
protected final Map<String,List<ScalarTypeExtensionDefinition>>	scalarTypeExtensions
protected final Map<String,ScalarTypeDefinition>	scalarTypes
protected @Nullable SchemaDefinition	schema
protected final List<SchemaExtensionDefinition>	schemaExtensionDefinitions
protected final SchemaParseOrder	schemaParseOrder
protected final Map<String,TypeDefinition>	types
protected final Map<String,List<UnionTypeExtensionDefinition>>	unionTypeExtensions

Constructor Summary

Constructors

Modifier	Constructor	Description
	TypeDefinitionRegistry()
protected	TypeDefinitionRegistry(Map<String,List<ObjectTypeExtensionDefinition>> objectTypeExtensions, Map<String,List<InterfaceTypeExtensionDefinition>> interfaceTypeExtensions, Map<String,List<UnionTypeExtensionDefinition>> unionTypeExtensions, Map<String,List<EnumTypeExtensionDefinition>> enumTypeExtensions, Map<String,List<ScalarTypeExtensionDefinition>> scalarTypeExtensions, Map<String,List<InputObjectTypeExtensionDefinition>> inputObjectTypeExtensions, Map<String,TypeDefinition> types, Map<String,ScalarTypeDefinition> scalarTypes, Map<String,DirectiveDefinition> directiveDefinitions, List<SchemaExtensionDefinition> schemaExtensionDefinitions, @Nullable SchemaDefinition schema, SchemaParseOrder schemaParseOrder)

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()
List<ImplementingTypeDefinition>	getAllImplementationsOf(InterfaceTypeDefinition targetInterface)	Returns the list of object and interface types that implement the given interface type
Optional<DirectiveDefinition>	getDirectiveDefinition(String directiveName)
Map<String,DirectiveDefinition>	getDirectiveDefinitions()
List<ObjectTypeDefinition>	getImplementationsOf(InterfaceTypeDefinition targetInterface)	Returns the list of object interface types that implement the given interface type
SchemaParseOrder	getParseOrder()
List<SchemaExtensionDefinition>	getSchemaExtensionDefinitions()
Optional<TypeDefinition>	getType(Type type)	Deprecated. use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object
<T extends TypeDefinition> Optional<T>	getType(Type type, Class<T> ofType)	Deprecated. use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object
Optional<TypeDefinition>	getType(String typeName)	Deprecated. use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object
<T extends TypeDefinition> Optional<T>	getType(String typeName, Class<T> ofType)	Deprecated. use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object
@Nullable TypeDefinition	getTypeOrNull(Type type)	Returns a TypeDefinition of the specified type or null
<T extends TypeDefinition> @Nullable T	getTypeOrNull(Type type, Class<T> ofType)	Returns a TypeDefinition of the specified type with the specified class or null
@Nullable TypeDefinition	getTypeOrNull(String typeName)	Returns a TypeDefinition of the specified name or null
<T extends TypeDefinition> @Nullable T	getTypeOrNull(String typeName, Class<T> ofType)	Returns a TypeDefinition of the specified name and class or null
<T extends TypeDefinition> List<T>	getTypes(Class<T> targetClass)	Returns a list of types in the registry of that specified class
<T extends TypeDefinition> Map<String,T>	getTypesMap(Class<T> targetClass)	Returns a map of types in the registry of that specified class keyed by name
boolean	hasType(TypeName typeName)	Returns true if the registry has a type of the specified TypeName
boolean	hasType(String name)	Returns true if the registry has a type of the specified name
Map<String,List<InputObjectTypeExtensionDefinition>>	inputObjectTypeExtensions()
Map<String,List<InterfaceTypeExtensionDefinition>>	interfaceTypeExtensions()
boolean	isInterfaceOrUnion(Type type)	Returns true if the specified type exists in the registry and is an abstract (Interface or Union) type
boolean	isObjectType(Type type)	Returns true if the specified type exists in the registry and is an object type
boolean	isObjectTypeOrInterface(Type type)	Returns true if the specified type exists in the registry and is an object type or interface
boolean	isPossibleType(Type abstractType, Type possibleType)	Returns true of the abstract type is in implemented by the object type or interface
boolean	isSubTypeOf(Type maybeSubType, Type superType)	Returns true if the maybe type is either equal or a subset of the second super type (covariant).
TypeDefinitionRegistry	merge(TypeDefinitionRegistry typeRegistry)	This will merge these type registries together and return this one
Map<String,List<ObjectTypeExtensionDefinition>>	objectTypeExtensions()
ImmutableTypeDefinitionRegistry	readOnly()
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()
Optional<SchemaDefinition>	schemaDefinition()
Map<String,TypeDefinition>	types()
Map<String,List<UnionTypeExtensionDefinition>>	unionTypeExtensions()

Methods inherited from class java.lang.Object

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

Field Details

objectTypeExtensions

protected final Map<String,List<ObjectTypeExtensionDefinition>> objectTypeExtensions

interfaceTypeExtensions

protected final Map<String,List<InterfaceTypeExtensionDefinition>> interfaceTypeExtensions

unionTypeExtensions

protected final Map<String,List<UnionTypeExtensionDefinition>> unionTypeExtensions

enumTypeExtensions

protected final Map<String,List<EnumTypeExtensionDefinition>> enumTypeExtensions

scalarTypeExtensions

protected final Map<String,List<ScalarTypeExtensionDefinition>> scalarTypeExtensions

inputObjectTypeExtensions

protected final Map<String,List<InputObjectTypeExtensionDefinition>> inputObjectTypeExtensions

types

protected final Map<String,TypeDefinition> types

scalarTypes

protected final Map<String,ScalarTypeDefinition> scalarTypes

directiveDefinitions

protected final Map<String,DirectiveDefinition> directiveDefinitions

schema

protected @Nullable SchemaDefinition schema

schemaExtensionDefinitions

protected final List<SchemaExtensionDefinition> schemaExtensionDefinitions

schemaParseOrder

protected final SchemaParseOrder schemaParseOrder

Constructor Details

TypeDefinitionRegistry

public TypeDefinitionRegistry()

TypeDefinitionRegistry

protected TypeDefinitionRegistry(Map<String,List<ObjectTypeExtensionDefinition>> objectTypeExtensions,
 Map<String,List<InterfaceTypeExtensionDefinition>> interfaceTypeExtensions,
 Map<String,List<UnionTypeExtensionDefinition>> unionTypeExtensions,
 Map<String,List<EnumTypeExtensionDefinition>> enumTypeExtensions,
 Map<String,List<ScalarTypeExtensionDefinition>> scalarTypeExtensions,
 Map<String,List<InputObjectTypeExtensionDefinition>> inputObjectTypeExtensions,
 Map<String,TypeDefinition> types,
 Map<String,ScalarTypeDefinition> scalarTypes,
 Map<String,DirectiveDefinition> directiveDefinitions,
 List<SchemaExtensionDefinition> schemaExtensionDefinitions,
 @Nullable SchemaDefinition schema,
 SchemaParseOrder schemaParseOrder)

Method Details

readOnly

public ImmutableTypeDefinitionRegistry readOnly()

Returns:

an immutable view of this TypeDefinitionRegistry that is more performant when in read only mode.

getParseOrder

public SchemaParseOrder getParseOrder()

Returns:

the order in which SDLDefinitions were parsed

merge

public TypeDefinitionRegistry merge(TypeDefinitionRegistry typeRegistry)
                             throws SchemaProblem

This will merge these type registries together and return this one

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)

Adds a a collections of definitions to the registry

Parameters:

definitions - the definitions to add

Returns:

an optional error for the first problem, typically type redefinition

add

public Optional<GraphQLError> add(SDLDefinition definition)

Adds a definition to the registry

Parameters:

definition - the definition to add

Returns:

an optional error

remove

public void remove(SDLDefinition definition)

Removes a SDLDefinition from the definition list.

Parameters:

definition - the definition to remove

remove

public void remove(String key,
 SDLDefinition definition)

Removes a SDLDefinition from a map.

Parameters:

key - the key to remove

definition - the definition to remove

types

public Map<String,TypeDefinition> types()

scalars

public Map<String,ScalarTypeDefinition> scalars()

objectTypeExtensions

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

interfaceTypeExtensions

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

unionTypeExtensions

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

enumTypeExtensions

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

scalarTypeExtensions

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

inputObjectTypeExtensions

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

schemaDefinition

public Optional<SchemaDefinition> schemaDefinition()

getSchemaExtensionDefinitions

public List<SchemaExtensionDefinition> getSchemaExtensionDefinitions()

getDirectiveDefinition

public Optional<DirectiveDefinition> getDirectiveDefinition(String directiveName)

getDirectiveDefinitions

public Map<String,DirectiveDefinition> getDirectiveDefinitions()

hasType

public boolean hasType(TypeName typeName)

Returns true if the registry has a type of the specified TypeName

Parameters:

typeName - the type name to check

Returns:

true if the registry has a type by that type name

hasType

public boolean hasType(String name)

Returns true if the registry has a type of the specified name

Parameters:

name - the name to check

Returns:

true if the registry has a type by that name

getType

@Deprecated(since="2025-07-7")
public Optional<TypeDefinition> getType(Type type)

Deprecated.

use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object

Returns an optional TypeDefinition of the specified type or Optional.empty()

Parameters:

type - the type to check

Returns:

an optional TypeDefinition or empty if it's not found

getType

@Deprecated(since="2025-07-7")
public <T extends TypeDefinition> Optional<T> getType(Type type,
 Class<T> ofType)

Deprecated.

use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object

Returns an optional TypeDefinition of the specified type with the specified class or Optional.empty()

Parameters:

type - the type to check

ofType - the class of TypeDefinition

Returns:

an optional TypeDefinition or empty if it's not found

getType

@Deprecated(since="2025-07-7")
public Optional<TypeDefinition> getType(String typeName)

Deprecated.

use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object

Returns an optional TypeDefinition of the specified type name or Optional.empty()

Parameters:

typeName - the type to check

Returns:

an optional TypeDefinition or empty if it's not found

getType

@Deprecated(since="2025-07-7")
public <T extends TypeDefinition> Optional<T> getType(String typeName,
 Class<T> ofType)

Deprecated.

use the getTypeOrNull(Type) variants instead since they avoid the allocation of an optional object

Returns an optional TypeDefinition of the specified type name with the specified class or Optional.empty()

Parameters:

typeName - the type to check

ofType - the class of TypeDefinition

getTypeOrNull

public @Nullable TypeDefinition getTypeOrNull(Type type)

Returns a TypeDefinition of the specified type or null

Parameters:

type - the type to check

Returns:

a TypeDefinition or null if it's not found

getTypeOrNull

public <T extends TypeDefinition> @Nullable T getTypeOrNull(Type type,
 Class<T> ofType)

Returns a TypeDefinition of the specified type with the specified class or null

Parameters:

type - the type to check

ofType - the class of TypeDefinition

Returns:

a TypeDefinition or null if it's not found

getTypeOrNull

public @Nullable TypeDefinition getTypeOrNull(String typeName)

Returns a TypeDefinition of the specified name or null

Parameters:

typeName - the type name to check

Returns:

a TypeDefinition or null if it's not found

getTypeOrNull

public <T extends TypeDefinition> @Nullable T getTypeOrNull(String typeName,
 Class<T> ofType)

Returns a TypeDefinition of the specified name and class or null

Parameters:

typeName - the type name to check

ofType - the class of TypeDefinition

Returns:

a TypeDefinition or null if it's not found

isInterfaceOrUnion

public boolean isInterfaceOrUnion(Type type)

Returns true if the specified type exists in the registry and is an abstract (Interface or Union) type

Parameters:

type - the type to check

Returns:

true if its abstract

isObjectTypeOrInterface

public boolean isObjectTypeOrInterface(Type type)

Returns true if the specified type exists in the registry and is an object type or interface

Parameters:

type - the type to check

Returns:

true if its an object type or interface

isObjectType

public boolean isObjectType(Type type)

Returns true if the specified type exists in the registry and is an object type

Parameters:

type - the type to check

Returns:

true if its an object type

getTypes

public <T extends TypeDefinition> List<T> getTypes(Class<T> targetClass)

Returns a list of types in the registry of that specified class

Type Parameters:

T - must extend TypeDefinition

Parameters:

targetClass - the class to search for

Returns:

a list of types of the target class

getTypesMap

public <T extends TypeDefinition> Map<String,T> getTypesMap(Class<T> targetClass)

Returns a map of types in the registry of that specified class keyed by name

Type Parameters:

T - must extend TypeDefinition

Parameters:

targetClass - the class to search for

Returns:

a map of types

getAllImplementationsOf

public List<ImplementingTypeDefinition> getAllImplementationsOf(InterfaceTypeDefinition targetInterface)

Returns the list of object and interface types that implement the given interface type

Parameters:

targetInterface - the target to search for

Returns:

the list of object types that implement the given interface type

See Also:

• getImplementationsOf(InterfaceTypeDefinition)

getImplementationsOf

public List<ObjectTypeDefinition> getImplementationsOf(InterfaceTypeDefinition targetInterface)

Returns the list of object interface types that implement the given interface type

Parameters:

targetInterface - the target to search for

Returns:

the list of object types that implement the given interface type

See Also:

• getAllImplementationsOf(InterfaceTypeDefinition)

isPossibleType

public boolean isPossibleType(Type abstractType,
 Type possibleType)

Returns true of the abstract type is in implemented by the object type or interface

Parameters:

abstractType - the abstract type to check (interface or union)

possibleType - the object type or interface to check

Returns:

true if the object type or interface implements the abstract type

isSubTypeOf

public boolean isSubTypeOf(Type maybeSubType,
 Type superType)

Returns true if the maybe type is either equal or a subset of the second super type (covariant).

Parameters:

maybeSubType - the type to check

superType - the equality checked type

Returns:

true if maybeSubType is covariant or equal to superType