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	descriptionsAsHashComments(boolean flag) Descriptions are defined as preceding string literals, however an older legacy versions of SDL supported preceding '#' comments as descriptions.
GraphqlTypeComparatorRegistry	getComparatorRegistry()
java.util.function.Predicate<GraphQLDirective>	getIncludeDirective()
SchemaPrinter.Options	includeDirectives(boolean flag) Allow to print directives.
SchemaPrinter.Options	includeDirectives(java.util.function.Predicate<GraphQLDirective> includeDirective)
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	includeSchemaDefinition(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	isDescriptionsAsHashComments()
boolean	isIncludeExtendedScalars()
boolean	isIncludeIntrospectionTypes()
boolean	isIncludeScalars()
boolean	isIncludeSchemaDefinition()
boolean	isUseAstDefinitions()
SchemaPrinter.Options	setComparators(GraphqlTypeComparatorRegistry comparatorRegistry) The comparator registry controls the printing order for registered GraphQLTypes.
SchemaPrinter.Options	useAstDefinitions(boolean flag) This flag controls whether schema printer will use the GraphQLType's original Ast TypeDefinitions when printing the type.

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()

getIncludeDirective

public java.util.function.Predicate<GraphQLDirective> getIncludeDirective()

isDescriptionsAsHashComments

public boolean isDescriptionsAsHashComments()

getComparatorRegistry

public GraphqlTypeComparatorRegistry getComparatorRegistry()

isUseAstDefinitions

public boolean isUseAstDefinitions()

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

includeSchemaDefinition

public SchemaPrinter.Options includeSchemaDefinition(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

includeDirectives

public SchemaPrinter.Options includeDirectives(boolean flag)

Allow to print directives. In some situations, auto-generated schemas contain a lot of directives that make the printout noisy and having this flag would allow cleaner printout. On by default.

Parameters:

flag - whether to print directives

Returns:

new instance of options

includeDirectives

public SchemaPrinter.Options includeDirectives(java.util.function.Predicate<GraphQLDirective> includeDirective)

useAstDefinitions

public SchemaPrinter.Options useAstDefinitions(boolean flag)

This flag controls whether schema printer will use the GraphQLType's original Ast TypeDefinitions when printing the type. This allows access to any `extend type` declarations that might have been originally made.

Parameters:

flag - whether to print via AST type definitions

Returns:

new instance of options

descriptionsAsHashComments

public SchemaPrinter.Options descriptionsAsHashComments(boolean flag)

Descriptions are defined as preceding string literals, however an older legacy versions of SDL supported preceding '#' comments as descriptions. Set this to true to enable this deprecated behavior. This option is provided to ease adoption and may be removed in future versions.

Parameters:

flag - whether to print description as # comments

Returns:

new instance of options

setComparators

public SchemaPrinter.Options setComparators(GraphqlTypeComparatorRegistry comparatorRegistry)

The comparator registry controls the printing order for registered GraphQLTypes.

The default is to sort elements by name but you can put in your own code to decide on the field order

Parameters:

comparatorRegistry - The registry containing the Comparator and environment scoping rules.

Returns:

options