Skip to content

Better javadoc on how code is found during SchemaGeneration #3162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbakerman merged 1 commit into from
Apr 2, 2023
Merged

Better javadoc on how code is found during SchemaGeneration #3162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/main/java/graphql/schema/idl/SchemaGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,33 @@

/**
* This can generate a working runtime schema from a type registry and runtime wiring
* <p>
* The generator uses the {@link RuntimeWiring} to insert code that runs behind the schema
* elements such as {@link graphql.schema.DataFetcher}s, {@link graphql.schema.TypeResolver}s
* and scalar {@link graphql.schema.Coercing}.
* <p>
* The order of {@link graphql.schema.DataFetcher} resolution is as follows:
* <ol>
* <li>If the {@link WiringFactory} provides the {@link graphql.schema.DataFetcherFactory} for a field in its parent type then that is used</li>
* <li>If the {@link WiringFactory} provides the {@link graphql.schema.DataFetcher} for a field in its parent type then that is used</li>
* <li>If the {@link RuntimeWiring} provides the {@link graphql.schema.DataFetcher} for a field in its parent type, then that is used</li>
* <li>If the {@link RuntimeWiring} provides a default {@link graphql.schema.DataFetcher} for a fields parent type, then that is used</li>
* <li>If the {@link WiringFactory} provides a default {@link graphql.schema.DataFetcherFactory} for any element then that is used</li>
* <li>If the {@link GraphQLCodeRegistry.Builder#getDefaultDataFetcherFactory()} provides a {@link graphql.schema.DataFetcherFactory} for a value then that is used</li>
* <li>Finally a {@link graphql.schema.PropertyDataFetcher} is used as a last resort for the field</li>
* </ol>
* <p>
* The order of {@link graphql.schema.TypeResolver} resolution is as follows:
* <ol>
* <li>If the {@link WiringFactory} provides a {@link graphql.schema.TypeResolver} then that is used</li>
* <li>If the {@link TypeRuntimeWiring} provides a {@link graphql.schema.TypeResolver} then that is used</li>
* </ol>
* <p>
* The order of {@link graphql.schema.GraphQLScalarType} resolution is as follows:
* <ol>
* <li>If the {@link WiringFactory} provides a {@link graphql.schema.GraphQLScalarType} then that is used</li>
* <li>Otherwise {@link RuntimeWiring#getScalars()} is used</li>
* </ol>
*/
@PublicApi
public class SchemaGenerator {
Expand Down