Class SchemaPrinter

java.lang.Object

graphql.schema.idl.SchemaPrinter

@PublicApi
public class SchemaPrinter
extends Object

This can print an in memory GraphQL schema back to a logical schema definition

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaPrinter.Options	Options to use when printing a schema
private static interface	SchemaPrinter.SchemaElementPrinter<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<String>	ExcludeGraphQLSpecifiedDirectivesPredicate	This predicate excludes all directives which are specified by the GraphQL Specification.
private final SchemaPrinter.Options	options
private final Map<Class<?>, SchemaPrinter.SchemaElementPrinter<?>>	printers

Constructor Summary

Constructors

Constructor	Description
SchemaPrinter()
SchemaPrinter(SchemaPrinter.Options options)

Method Summary

Modifier and Type	Method	Description
private List<GraphQLAppliedDirective>	addDeprecatedDirectiveIfNeeded(GraphQLDirectiveContainer directiveContainer)
(package private) String	argsString(Class<? extends GraphQLSchemaElement> parent, List<GraphQLArgument> arguments)
(package private) String	argsString(List<GraphQLArgument> arguments)
private String	comments(List<Comment> comments)
(package private) String	description(String runtimeDescription, Description descriptionAst)
private String	directiveDefinition(GraphQLDirective directive)
private SchemaPrinter.SchemaElementPrinter<GraphQLDirective>	directivePrinter()
(package private) String	directivesString(Class<? extends GraphQLSchemaElement> parentType, boolean isDeprecated, GraphQLDirectiveContainer directiveContainer)
String	directivesString(Class<? extends GraphQLSchemaElement> parentType, GraphQLDirectiveContainer directiveContainer)
private String	directivesString(Class<? extends GraphQLSchemaElement> parentType, List<GraphQLAppliedDirective> directives)
private String	directiveString(GraphQLAppliedDirective directive)
private SchemaPrinter.SchemaElementPrinter<GraphQLEnumType>	enumPrinter()
private String	getAstDefinitionComments(Object commentHolder)
private Comparator<? super GraphQLSchemaElement>	getComparator(Class<? extends GraphQLSchemaElement> parentType, Class<? extends GraphQLSchemaElement> elementType)
private String	getDeprecationReason(GraphQLDirectiveContainer directiveContainer)
private String	getDescription(Object descriptionHolder)
private List<GraphQLDirective>	getSchemaDirectives(GraphQLSchema schema)
private boolean	hasAstDefinitionComments(Object commentHolder)
private boolean	hasDeprecatedDirective(List<GraphQLAppliedDirective> directives)
private boolean	hasDescription(Object descriptionHolder)
private SchemaPrinter.SchemaElementPrinter<GraphQLInputObjectType>	inputObjectPrinter()
private SchemaPrinter.SchemaElementPrinter<GraphQLInterfaceType>	interfacePrinter()
private boolean	isDeprecatedDirective(GraphQLAppliedDirective directive)
private boolean	isIntrospectionType(GraphQLNamedType type)
private static boolean	isNullOrEmpty(String s)
private SchemaPrinter.SchemaElementPrinter<GraphQLObjectType>	objectPrinter()
String	print(Document schemaIDL)	This can print an in memory GraphQL IDL document back to a logical schema definition.
String	print(GraphQLDirective graphQLDirective)
String	print(GraphQLSchema schema)	This can print an in memory GraphQL schema back to a logical schema definition
String	print(GraphQLType type)
String	print(List<GraphQLSchemaElement> elements)
private void	printAsAst(PrintWriter out, TypeDefinition<?> definition, List<? extends TypeDefinition<?>> extensions)	This will print out a runtime graphql schema element using its contained AST type definition.
private static String	printAst(InputValueWithState value, GraphQLInputType type)
private void	printComments(PrintWriter out, Object graphQLType, String prefix)
private String	printComments(Object graphQLType, String prefix)
private <T> SchemaPrinter.SchemaElementPrinter<T>	printer(Class<?> clazz)
private void	printFieldDefinitions(PrintWriter out, Comparator<? super GraphQLSchemaElement> comparator, List<GraphQLFieldDefinition> fieldDefinitions)
private void	printMultiLineDescription(PrintWriter out, String prefix, List<String> lines)
private void	printMultiLineHashDescription(PrintWriter out, String prefix, List<String> lines)
private void	printSchemaElement(PrintWriter out, GraphQLSchemaElement schemaElement, GraphqlFieldVisibility visibility)
private void	printSingleLineDescription(PrintWriter out, String prefix, String s)
private SchemaPrinter.SchemaElementPrinter<GraphQLScalarType>	scalarPrinter()
private SchemaPrinter.SchemaElementPrinter<GraphQLSchema>	schemaPrinter()
private boolean	shouldPrintAsAst(TypeDefinition<?> definition)	This will return true if the options say to use the AST and we have an AST element
private static String	trimNewLineChars(String s)
(package private) String	typeString(GraphQLType rawType)
private SchemaPrinter.SchemaElementPrinter<GraphQLUnionType>	unionPrinter()

Methods inherited from class Object

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

Field Details

ExcludeGraphQLSpecifiedDirectivesPredicate

public static final Predicate<String> ExcludeGraphQLSpecifiedDirectivesPredicate

This predicate excludes all directives which are specified by the GraphQL Specification. Printing these directives is optional.

printers

private final Map<Class<?>, SchemaPrinter.SchemaElementPrinter<?>> printers

options

private final SchemaPrinter.Options options

Constructor Details

SchemaPrinter

public SchemaPrinter()

SchemaPrinter

public SchemaPrinter(SchemaPrinter.Options options)

Method Details

print

public String print(Document schemaIDL)

This can print an in memory GraphQL IDL document back to a logical schema definition. If you want to turn a Introspection query result into a Document (and then into a printed schema) then use IntrospectionResultToSchema.createSchemaDefinition(java.util.Map) first to get the Document and then print that.

Parameters:

schemaIDL - the parsed schema IDL

Returns:

the logical schema definition

print

public String print(GraphQLSchema schema)

This can print an in memory GraphQL schema back to a logical schema definition

Parameters:

schema - the schema in play

Returns:

the logical schema definition

isIntrospectionType

private boolean isIntrospectionType(GraphQLNamedType type)

scalarPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLScalarType> scalarPrinter()

enumPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLEnumType> enumPrinter()

printFieldDefinitions

private void printFieldDefinitions(PrintWriter out,
 Comparator<? super GraphQLSchemaElement> comparator,
 List<GraphQLFieldDefinition> fieldDefinitions)

interfacePrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLInterfaceType> interfacePrinter()

unionPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLUnionType> unionPrinter()

directivePrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLDirective> directivePrinter()

objectPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLObjectType> objectPrinter()

inputObjectPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLInputObjectType> inputObjectPrinter()

shouldPrintAsAst

private boolean shouldPrintAsAst(TypeDefinition<?> definition)

This will return true if the options say to use the AST and we have an AST element

Parameters:

definition - the AST type definition

Returns:

true if we should print using AST nodes

printAsAst

private void printAsAst(PrintWriter out,
 TypeDefinition<?> definition,
 List<? extends TypeDefinition<?>> extensions)

This will print out a runtime graphql schema element using its contained AST type definition. This must be guarded by a called to shouldPrintAsAst(TypeDefinition)

Parameters:

out - the output writer

definition - the AST type definition

extensions - a list of type definition extensions

printAst

private static String printAst(InputValueWithState value,
 GraphQLInputType type)

schemaPrinter

private SchemaPrinter.SchemaElementPrinter<GraphQLSchema> schemaPrinter()

getSchemaDirectives

private List<GraphQLDirective> getSchemaDirectives(GraphQLSchema schema)

typeString

String typeString(GraphQLType rawType)

argsString

String argsString(List<GraphQLArgument> arguments)

argsString

String argsString(Class<? extends GraphQLSchemaElement> parent,
 List<GraphQLArgument> arguments)

directivesString

public String directivesString(Class<? extends GraphQLSchemaElement> parentType,
 GraphQLDirectiveContainer directiveContainer)

directivesString

String directivesString(Class<? extends GraphQLSchemaElement> parentType,
 boolean isDeprecated,
 GraphQLDirectiveContainer directiveContainer)

directivesString

private String directivesString(Class<? extends GraphQLSchemaElement> parentType,
 List<GraphQLAppliedDirective> directives)

directiveString

private String directiveString(GraphQLAppliedDirective directive)

isDeprecatedDirective

private boolean isDeprecatedDirective(GraphQLAppliedDirective directive)

hasDeprecatedDirective

private boolean hasDeprecatedDirective(List<GraphQLAppliedDirective> directives)

addDeprecatedDirectiveIfNeeded

private List<GraphQLAppliedDirective> addDeprecatedDirectiveIfNeeded(GraphQLDirectiveContainer directiveContainer)

getDeprecationReason

private String getDeprecationReason(GraphQLDirectiveContainer directiveContainer)

directiveDefinition

private String directiveDefinition(GraphQLDirective directive)

printer

private <T> SchemaPrinter.SchemaElementPrinter<T> printer(Class<?> clazz)

print

public String print(GraphQLType type)

print

public String print(List<GraphQLSchemaElement> elements)

print

public String print(GraphQLDirective graphQLDirective)

printSchemaElement

private void printSchemaElement(PrintWriter out,
 GraphQLSchemaElement schemaElement,
 GraphqlFieldVisibility visibility)

printComments

private String printComments(Object graphQLType,
 String prefix)

printComments

private void printComments(PrintWriter out,
 Object graphQLType,
 String prefix)

printMultiLineHashDescription

private void printMultiLineHashDescription(PrintWriter out,
 String prefix,
 List<String> lines)

printMultiLineDescription

private void printMultiLineDescription(PrintWriter out,
 String prefix,
 List<String> lines)

printSingleLineDescription

private void printSingleLineDescription(PrintWriter out,
 String prefix,
 String s)

hasAstDefinitionComments

private boolean hasAstDefinitionComments(Object commentHolder)

getAstDefinitionComments

private String getAstDefinitionComments(Object commentHolder)

comments

private String comments(List<Comment> comments)

hasDescription

private boolean hasDescription(Object descriptionHolder)

getDescription

private String getDescription(Object descriptionHolder)

description

String description(String runtimeDescription,
 Description descriptionAst)

getComparator

private Comparator<? super GraphQLSchemaElement> getComparator(Class<? extends GraphQLSchemaElement> parentType,
 Class<? extends GraphQLSchemaElement> elementType)

trimNewLineChars

private static String trimNewLineChars(String s)

isNullOrEmpty

private static boolean isNullOrEmpty(String s)