GraphQLSchema (graphql-java 2021-04-19T03-51-46-d783ec7e API)

java.lang.Object
- graphql.schema.GraphQLSchema

```
@PublicApi
public class GraphQLSchema
extends java.lang.Object
```
The schema represents the combined type system of the graphql engine. This is how the engine knows what graphql queries represent what data.
See http://graphql.org/learn/schema/#type-language for more details

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GraphQLSchema.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`GraphQLSchema.Builder`

Constructor Summary

Constructors
Constructor and Description
`GraphQLSchema(GraphQLObjectType queryType)` Deprecated. use the `newSchema()` builder pattern instead, as this constructor will be made private in a future version.
`GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, GraphQLObjectType subscriptionType, java.util.Set<GraphQLType> additionalTypes)` Deprecated. use the `newSchema()` builder pattern instead, as this constructor will be made private in a future version.
`GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, java.util.Set<GraphQLType> additionalTypes)` Deprecated. use the `newSchema()` builder pattern instead, as this constructor will be made private in a future version.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsType(java.lang.String typeName)` Returns true if the schema contains a type with the specified name
`java.util.Set<GraphQLType>`	`getAdditionalTypes()`
`java.util.Map<java.lang.String,java.util.List<GraphQLDirective>>`	`getAllDirectivesByName()` Directives can be `repeatable` and hence this returns a list of directives by name, some with an arity of 1 and some with an arity of greater than 1.
`java.util.Map<java.lang.String,java.util.List<GraphQLDirective>>`	`getAllSchemaDirectivesByName()` Schema directives can be `repeatable` and hence this returns a list of directives by name, some with an arity of 1 and some with an arity of greater than 1.
`java.util.List<GraphQLNamedType>`	`getAllTypesAsList()`
`GraphQLCodeRegistry`	`getCodeRegistry()`
`SchemaDefinition`	`getDefinition()`
`java.lang.String`	`getDescription()`
`GraphQLDirective`	`getDirective(java.lang.String directiveName)` Returns a named directive that (for legacy reasons) will be only in the set of non repeatable directives
`java.util.List<GraphQLDirective>`	`getDirectives()` This returns the list of directives that are associated with this schema object including built in ones.
`java.util.List<GraphQLDirective>`	`getDirectives(java.lang.String directiveName)` Returns a list of named directive that can include non repeatable and repeatable directives.
`java.util.Map<java.lang.String,GraphQLDirective>`	`getDirectivesByName()`
`java.util.List<SchemaExtensionDefinition>`	`getExtensionDefinitions()`
`GraphqlFieldVisibility`	`getFieldVisibility()` Deprecated. use `GraphQLCodeRegistry.getFieldVisibility()` instead
`GraphQLDirective`	`getFirstDirective(java.lang.String directiveName)` Returns a the first named directive that can include non repeatable and repeatable directives or null if there is not one called that name
`java.util.List<GraphQLObjectType>`	`getImplementations(GraphQLInterfaceType type)` This will return the list of `GraphQLObjectType` types that implement the given interface type.
`GraphQLFieldDefinition`	`getIntrospectionSchemaFieldDefinition()`
`GraphQLObjectType`	`getIntrospectionSchemaType()`
`GraphQLFieldDefinition`	`getIntrospectionTypeFieldDefinition()`
`GraphQLFieldDefinition`	`getIntrospectionTypenameFieldDefinition()`
`GraphQLObjectType`	`getMutationType()`
`GraphQLObjectType`	`getObjectType(java.lang.String typeName)` Called to return a named `GraphQLObjectType` from the schema
`GraphQLObjectType`	`getQueryType()`
`GraphQLDirective`	`getSchemaDirective(java.lang.String directiveName)` This returns the named directive that have been explicitly put on the schema object.
`java.util.Map<java.lang.String,GraphQLDirective>`	`getSchemaDirectiveByName()` This returns a map of non repeatable directives that have been explicitly put on the schema object.
`java.util.List<GraphQLDirective>`	`getSchemaDirectives()` This returns the list of directives that have been explicitly put on the schema object.
`java.util.List<GraphQLDirective>`	`getSchemaDirectives(java.lang.String directiveName)`
`GraphQLObjectType`	`getSubscriptionType()`
`GraphQLType`	`getType(java.lang.String typeName)` Gets the named type from the schema or null if its not present
`<T extends GraphQLType> T`	`getTypeAs(java.lang.String typeName)` Gets the named type from the schema or null if its not present.
`java.util.Map<java.lang.String,GraphQLNamedType>`	`getTypeMap()`
`boolean`	`isPossibleType(GraphQLNamedType abstractType, GraphQLObjectType concreteType)` Returns true if a specified concrete type is a possible type of a provided abstract type.
`boolean`	`isSupportingMutations()`
`boolean`	`isSupportingSubscriptions()`
`static GraphQLSchema.Builder`	`newSchema()`
`static GraphQLSchema.Builder`	`newSchema(GraphQLSchema existingSchema)` This allows you to build a schema from an existing schema.
`GraphQLSchema`	`transform(java.util.function.Consumer<GraphQLSchema.Builder> builderConsumer)` This helps you transform the current GraphQLSchema object into another one by starting a builder with all the current values and allows you to transform it how you want.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphQLSchema
```
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType)
```
    Deprecated. use the newSchema() builder pattern instead, as this constructor will be made private in a future version.
    
    Parameters:
    
    queryType - the query type
  - GraphQLSchema
```
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType,
                                 GraphQLObjectType mutationType,
                                 java.util.Set<GraphQLType> additionalTypes)
```
    Deprecated. use the newSchema() builder pattern instead, as this constructor will be made private in a future version.
    
    Parameters:
    
    queryType - the query type
    
    mutationType - the mutation type
    
    additionalTypes - additional types
  - GraphQLSchema
```
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType,
                                 GraphQLObjectType mutationType,
                                 GraphQLObjectType subscriptionType,
                                 java.util.Set<GraphQLType> additionalTypes)
```
    Deprecated. use the newSchema() builder pattern instead, as this constructor will be made private in a future version.
    
    Parameters:
    
    queryType - the query type
    
    mutationType - the mutation type
    
    subscriptionType - the subscription type
    
    additionalTypes - additional types
- Method Detail
  - newSchema
```
public static GraphQLSchema.Builder newSchema()
```
    Returns:
    
    a new schema builder
  - newSchema
```
public static GraphQLSchema.Builder newSchema(GraphQLSchema existingSchema)
```
    This allows you to build a schema from an existing schema. It copies everything from the existing schema and then allows you to replace them.
    
    Parameters:
    
    existingSchema - the existing schema
    
    Returns:
    
    a new schema builder
  - getCodeRegistry
```
public GraphQLCodeRegistry getCodeRegistry()
```
  - getIntrospectionSchemaFieldDefinition
```
public GraphQLFieldDefinition getIntrospectionSchemaFieldDefinition()
```
    Returns:
    
    the special system field called "__schema"
  - getIntrospectionTypeFieldDefinition
```
public GraphQLFieldDefinition getIntrospectionTypeFieldDefinition()
```
    Returns:
    
    the special system field called "__type"
  - getIntrospectionTypenameFieldDefinition
```
public GraphQLFieldDefinition getIntrospectionTypenameFieldDefinition()
```
    Returns:
    
    the special system field called "__typename"
  - getIntrospectionSchemaType
```
public GraphQLObjectType getIntrospectionSchemaType()
```
  - getAdditionalTypes
```
public java.util.Set<GraphQLType> getAdditionalTypes()
```
  - getType
```
public GraphQLType getType(java.lang.String typeName)
```
    Gets the named type from the schema or null if its not present
    
    Parameters:
    
    typeName - the name of the type to retrieve
    
    Returns:
    
    the type
  - getTypeAs
```
public <T extends GraphQLType> T getTypeAs(java.lang.String typeName)
```
    Gets the named type from the schema or null if its not present. Warning - your are inviting class cast errors if you the types are not what you expect.
    
    Type Parameters:
    
    T - for two
    
    Parameters:
    
    typeName - the name of the type to retrieve
    
    Returns:
    
    the type cast to the target type.
  - containsType
```
public boolean containsType(java.lang.String typeName)
```
    Returns true if the schema contains a type with the specified name
    
    Parameters:
    
    typeName - the name of the type to check
    
    Returns:
    
    true if there is a type with the specified name
  - getObjectType
```
public GraphQLObjectType getObjectType(java.lang.String typeName)
```
    Called to return a named GraphQLObjectType from the schema
    
    Parameters:
    
    typeName - the name of the type
    
    Returns:
    
    a graphql object type or null if there is one
    
    Throws:
    
    GraphQLException - if the type is NOT a object type
  - getTypeMap
```
public java.util.Map<java.lang.String,GraphQLNamedType> getTypeMap()
```
  - getAllTypesAsList
```
public java.util.List<GraphQLNamedType> getAllTypesAsList()
```
  - getImplementations
```
public java.util.List<GraphQLObjectType> getImplementations(GraphQLInterfaceType type)
```
    This will return the list of GraphQLObjectType types that implement the given interface type.
    
    Parameters:
    
    type - interface type to obtain implementations of.
    
    Returns:
    
    list of types implementing provided interface
  - isPossibleType
```
public boolean isPossibleType(GraphQLNamedType abstractType,
                              GraphQLObjectType concreteType)
```
    Returns true if a specified concrete type is a possible type of a provided abstract type. If the provided abstract type is: - an interface, it checks whether the concrete type is one of its implementations. - a union, it checks whether the concrete type is one of its possible types.
    
    Parameters:
    
    abstractType - abstract type either interface or union
    
    concreteType - concrete type
    
    Returns:
    
    true if possible type, false otherwise.
  - getQueryType
```
public GraphQLObjectType getQueryType()
```
  - getMutationType
```
public GraphQLObjectType getMutationType()
```
  - getSubscriptionType
```
public GraphQLObjectType getSubscriptionType()
```
  - getFieldVisibility
```
@Deprecated
public GraphqlFieldVisibility getFieldVisibility()
```
    Deprecated. use GraphQLCodeRegistry.getFieldVisibility() instead
    
    Returns:
    
    the field visibility
  - getDirectives
```
public java.util.List<GraphQLDirective> getDirectives()
```
    This returns the list of directives that are associated with this schema object including built in ones.
    
    Returns:
    
    a list of directives
  - getDirectivesByName
```
public java.util.Map<java.lang.String,GraphQLDirective> getDirectivesByName()
```
    Returns:
    
    a a map of non repeatable directives by directive name
  - getAllDirectivesByName
```
public java.util.Map<java.lang.String,java.util.List<GraphQLDirective>> getAllDirectivesByName()
```
    Directives can be `repeatable` and hence this returns a list of directives by name, some with an arity of 1 and some with an arity of greater than 1.
    
    Returns:
    
    a map of all directives by directive name
  - getDirective
```
public GraphQLDirective getDirective(java.lang.String directiveName)
```
    Returns a named directive that (for legacy reasons) will be only in the set of non repeatable directives
    
    Parameters:
    
    directiveName - the name of the directive to retrieve
    
    Returns:
    
    the directive or null if there is not one with that name
  - getDirectives
```
public java.util.List<GraphQLDirective> getDirectives(java.lang.String directiveName)
```
    Returns a list of named directive that can include non repeatable and repeatable directives.
    
    Parameters:
    
    directiveName - the name of the directives to retrieve
    
    Returns:
    
    the directive or empty list if there is not one with that name
  - getFirstDirective
```
public GraphQLDirective getFirstDirective(java.lang.String directiveName)
```
    Returns a the first named directive that can include non repeatable and repeatable directives or null if there is not one called that name
    
    Parameters:
    
    directiveName - the name of the directives to retrieve
    
    Returns:
    
    the directive or null if there is not one with that name
  - getSchemaDirectives
```
public java.util.List<GraphQLDirective> getSchemaDirectives()
```
    This returns the list of directives that have been explicitly put on the schema object. Note that getDirectives() will return directives for all schema elements, whereas this is just for the schema element itself
    
    Returns:
    
    a list of directives
  - getSchemaDirectiveByName
```
public java.util.Map<java.lang.String,GraphQLDirective> getSchemaDirectiveByName()
```
    This returns a map of non repeatable directives that have been explicitly put on the schema object. Note that getDirectives() will return directives for all schema elements, whereas this is just for the schema element itself
    
    Returns:
    
    a list of directives
  - getAllSchemaDirectivesByName
```
public java.util.Map<java.lang.String,java.util.List<GraphQLDirective>> getAllSchemaDirectivesByName()
```
    Schema directives can be `repeatable` and hence this returns a list of directives by name, some with an arity of 1 and some with an arity of greater than 1.
    
    Returns:
    
    a map of all schema directives by directive name
  - getSchemaDirective
```
public GraphQLDirective getSchemaDirective(java.lang.String directiveName)
```
    This returns the named directive that have been explicitly put on the schema object. Note that GraphQLDirectiveContainer.getDirective(String) will return directives for all schema elements, whereas this is just for the schema element itself
    
    Parameters:
    
    directiveName - the name of the directive
    
    Returns:
    
    a named directive
  - getSchemaDirectives
```
public java.util.List<GraphQLDirective> getSchemaDirectives(java.lang.String directiveName)
```
  - getDefinition
```
public SchemaDefinition getDefinition()
```
  - getExtensionDefinitions
```
public java.util.List<SchemaExtensionDefinition> getExtensionDefinitions()
```
  - isSupportingMutations
```
public boolean isSupportingMutations()
```
  - isSupportingSubscriptions
```
public boolean isSupportingSubscriptions()
```
  - getDescription
```
public java.lang.String getDescription()
```
  - transform
```
public GraphQLSchema transform(java.util.function.Consumer<GraphQLSchema.Builder> builderConsumer)
```
    This helps you transform the current GraphQLSchema object into another one by starting a builder with all the current values and allows you to transform it how you want.
    
    Parameters:
    
    builderConsumer - the consumer code that will be given a builder to transform
    
    Returns:
    
    a new GraphQLSchema object based on calling build on that builder

Class GraphQLSchema

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphQLSchema

GraphQLSchema

GraphQLSchema

Method Detail

newSchema

newSchema

getCodeRegistry

getIntrospectionSchemaFieldDefinition

getIntrospectionTypeFieldDefinition

getIntrospectionTypenameFieldDefinition

getIntrospectionSchemaType

getAdditionalTypes

getType

getTypeAs

containsType

getObjectType

getTypeMap

getAllTypesAsList

getImplementations

isPossibleType

getQueryType

getMutationType

getSubscriptionType

getFieldVisibility

getDirectives

getDirectivesByName

getAllDirectivesByName

getDirective

getDirectives

getFirstDirective

getSchemaDirectives

getSchemaDirectiveByName

getAllSchemaDirectivesByName

getSchemaDirective

getSchemaDirectives

getDefinition

getExtensionDefinitions

isSupportingMutations

isSupportingSubscriptions

getDescription

transform