graphql.schema.idl

Class TypeDefinitionRegistry

java.lang.Object

graphql.schema.idl.TypeDefinitionRegistry

@PublicApi
public class TypeDefinitionRegistry
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
TypeDefinitionRegistry()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<GraphQLError>	add(SDLDefinition definition) Adds a definition to the registry
java.util.Optional<GraphQLError>	addAll(java.util.Collection<SDLDefinition> definitions) Adds a a collections of definitions to the registry
java.util.Map<java.lang.String,java.util.List<EnumTypeExtensionDefinition>>	enumTypeExtensions()
java.util.Optional<DirectiveDefinition>	getDirectiveDefinition(java.lang.String directiveName)
java.util.Map<java.lang.String,DirectiveDefinition>	getDirectiveDefinitions()
java.util.List<ObjectTypeDefinition>	getImplementationsOf(InterfaceTypeDefinition targetInterface) Returns the list of object types that implement the given interface type
java.util.Optional<TypeDefinition>	getType(java.lang.String typeName)
<T extends TypeDefinition> java.util.Optional<T>	getType(java.lang.String typeName, java.lang.Class<T> ofType)
java.util.Optional<TypeDefinition>	getType(Type type)
<T extends TypeDefinition> java.util.Optional<T>	getType(Type type, java.lang.Class<T> ofType)
<T extends TypeDefinition> java.util.List<T>	getTypes(java.lang.Class<T> targetClass) Returns a list of types in the registry of that specified class
<T extends TypeDefinition> java.util.Map<java.lang.String,T>	getTypesMap(java.lang.Class<T> targetClass) Returns a map of types in the registry of that specified class keyed by name
boolean	hasType(TypeName typeName)
java.util.Map<java.lang.String,java.util.List<InputObjectTypeExtensionDefinition>>	inputObjectTypeExtensions()
java.util.Map<java.lang.String,java.util.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	isPossibleType(Type abstractType, Type possibleObjectType) Returns true of the abstract type is in implemented by the object type
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
java.util.Map<java.lang.String,java.util.List<ObjectTypeExtensionDefinition>>	objectTypeExtensions()
void	remove(SDLDefinition definition)
java.util.Map<java.lang.String,ScalarTypeDefinition>	scalars()
java.util.Map<java.lang.String,java.util.List<ScalarTypeExtensionDefinition>>	scalarTypeExtensions()
java.util.Optional<SchemaDefinition>	schemaDefinition()
java.util.Map<java.lang.String,TypeDefinition>	types()
java.util.Map<java.lang.String,java.util.List<UnionTypeExtensionDefinition>>	unionTypeExtensions()

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeDefinitionRegistry

public TypeDefinitionRegistry()

Method Detail

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 java.util.Optional<GraphQLError> addAll(java.util.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 java.util.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)

types

public java.util.Map<java.lang.String,TypeDefinition> types()

scalars

public java.util.Map<java.lang.String,ScalarTypeDefinition> scalars()

objectTypeExtensions

public java.util.Map<java.lang.String,java.util.List<ObjectTypeExtensionDefinition>> objectTypeExtensions()

interfaceTypeExtensions

public java.util.Map<java.lang.String,java.util.List<InterfaceTypeExtensionDefinition>> interfaceTypeExtensions()

unionTypeExtensions

public java.util.Map<java.lang.String,java.util.List<UnionTypeExtensionDefinition>> unionTypeExtensions()

enumTypeExtensions

public java.util.Map<java.lang.String,java.util.List<EnumTypeExtensionDefinition>> enumTypeExtensions()

scalarTypeExtensions

public java.util.Map<java.lang.String,java.util.List<ScalarTypeExtensionDefinition>> scalarTypeExtensions()

inputObjectTypeExtensions

public java.util.Map<java.lang.String,java.util.List<InputObjectTypeExtensionDefinition>> inputObjectTypeExtensions()

schemaDefinition

public java.util.Optional<SchemaDefinition> schemaDefinition()

getDirectiveDefinition

public java.util.Optional<DirectiveDefinition> getDirectiveDefinition(java.lang.String directiveName)

getDirectiveDefinitions

public java.util.Map<java.lang.String,DirectiveDefinition> getDirectiveDefinitions()

hasType

public boolean hasType(TypeName typeName)

getType

public java.util.Optional<TypeDefinition> getType(Type type)

getType

public <T extends TypeDefinition> java.util.Optional<T> getType(Type type,
                                                                java.lang.Class<T> ofType)

getType

public java.util.Optional<TypeDefinition> getType(java.lang.String typeName)

getType

public <T extends TypeDefinition> java.util.Optional<T> getType(java.lang.String typeName,
                                                                java.lang.Class<T> ofType)

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

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> java.util.List<T> getTypes(java.lang.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> java.util.Map<java.lang.String,T> getTypesMap(java.lang.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

getImplementationsOf

public java.util.List<ObjectTypeDefinition> getImplementationsOf(InterfaceTypeDefinition targetInterface)

Returns the list of object 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

isPossibleType

public boolean isPossibleType(Type abstractType,
                              Type possibleObjectType)

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

Parameters:

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

possibleObjectType - the object type to check

Returns:

true if the object type 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