graphql.schema.idl

Class SchemaPrinter.Options

java.lang.Object

graphql.schema.idl.SchemaPrinter.Options

Enclosing class:

SchemaPrinter

public static class SchemaPrinter.Options
extends java.lang.Object

Options to use when printing a schema

Method Summary

Modifier and Type	Method and Description
static SchemaPrinter.Options	defaultOptions()
SchemaPrinter.Options	includeExtendedScalarTypes(boolean flag) This will allow you to include the graphql 'extended' scalar types that come with graphql-java such as GraphQLBigDecimal or GraphQLBigInteger
SchemaPrinter.Options	includeIntrospectionTypes(boolean flag) This will allow you to include introspection types that are contained in a schema
SchemaPrinter.Options	includeScalarTypes(boolean flag) This will allow you to include scalar types that are contained in a schema
SchemaPrinter.Options	includeSchemaDefintion(boolean flag) This will force the printing of the graphql schema definition even if the query, mutation, and/or subscription types use the default names.
boolean	isIncludeExtendedScalars()
boolean	isIncludeIntrospectionTypes()
boolean	isIncludeScalars()
boolean	isIncludeSchemaDefinition()

Methods inherited from class java.lang.Object

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

Method Detail

isIncludeIntrospectionTypes

public boolean isIncludeIntrospectionTypes()

isIncludeScalars

public boolean isIncludeScalars()

isIncludeExtendedScalars

public boolean isIncludeExtendedScalars()

isIncludeSchemaDefinition

public boolean isIncludeSchemaDefinition()

defaultOptions

public static SchemaPrinter.Options defaultOptions()

includeIntrospectionTypes

public SchemaPrinter.Options includeIntrospectionTypes(boolean flag)

This will allow you to include introspection types that are contained in a schema

Parameters:

flag - whether to include them

Returns:

options

includeScalarTypes

public SchemaPrinter.Options includeScalarTypes(boolean flag)

This will allow you to include scalar types that are contained in a schema

Parameters:

flag - whether to include them

Returns:

options

includeExtendedScalarTypes

public SchemaPrinter.Options includeExtendedScalarTypes(boolean flag)

This will allow you to include the graphql 'extended' scalar types that come with graphql-java such as GraphQLBigDecimal or GraphQLBigInteger

Parameters:

flag - whether to include them

Returns:

options

includeSchemaDefintion

public SchemaPrinter.Options includeSchemaDefintion(boolean flag)

This will force the printing of the graphql schema definition even if the query, mutation, and/or subscription types use the default names. Some graphql parsers require this information even if the schema uses the default type names. The schema definition will always be printed if any of the query, mutation, or subscription types do not use the default names.

Parameters:

flag - whether to force include the schema definition

Returns:

options