Package graphql.schema.idl

Class RuntimeWiring.Builder

java.lang.Object

graphql.schema.idl.RuntimeWiring.Builder

Enclosing class:

RuntimeWiring

@PublicApi
public static class RuntimeWiring.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
RuntimeWiring	build()
RuntimeWiring.Builder	codeRegistry(GraphQLCodeRegistry codeRegistry)	This allows you to seed in your own GraphQLCodeRegistry instance
RuntimeWiring.Builder	codeRegistry(GraphQLCodeRegistry.Builder codeRegistry)	This allows you to seed in your own GraphQLCodeRegistry instance
RuntimeWiring.Builder	comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry)	You can specify your own sort order of graphql types via GraphqlTypeComparatorRegistry which will tell you what type of objects you are to sort when it asks for a comparator.
RuntimeWiring.Builder	directive(String directiveName, SchemaDirectiveWiring schemaDirectiveWiring)	This provides the wiring code for a named directive.
RuntimeWiring.Builder	directiveWiring(SchemaDirectiveWiring schemaDirectiveWiring)	This adds a directive wiring that will be called for all directives.
RuntimeWiring.Builder	fieldVisibility(GraphqlFieldVisibility fieldVisibility)	This allows you to add a field visibility that will be associated with the schema
RuntimeWiring.Builder	scalar(GraphQLScalarType scalarType)	This allows you to add in new custom Scalar implementations beyond the standard set.
RuntimeWiring.Builder	strictMode()	Deprecated, for removal: This API element is subject to removal in a future version. strictMode default value changed to true, use strictMode(boolean) instead
RuntimeWiring.Builder	strictMode(boolean strictMode)	This sets strict mode as true or false.
RuntimeWiring.Builder	type(TypeRuntimeWiring typeRuntimeWiring)	This adds a type wiring
RuntimeWiring.Builder	type(TypeRuntimeWiring.Builder builder)	This allows you to add a new type wiring via a builder
RuntimeWiring.Builder	type(String typeName, UnaryOperator<TypeRuntimeWiring.Builder> builderFunction)	This form allows a lambda to be used as the builder of a type wiring
RuntimeWiring.Builder	wiringFactory(WiringFactory wiringFactory)	Adds a wiring factory into the runtime wiring

Methods inherited from class java.lang.Object

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

Method Details

strictMode

public RuntimeWiring.Builder strictMode(boolean strictMode)

This sets strict mode as true or false. If strictMode is true, if things get defined twice, for example, it will throw a StrictModeWiringException.

Returns:

this builder

strictMode

@Deprecated(since="2025-03-22",
            forRemoval=true)
public RuntimeWiring.Builder strictMode()

Deprecated, for removal: This API element is subject to removal in a future version.

strictMode default value changed to true, use strictMode(boolean) instead

This puts the builder into strict mode, so if things get defined twice, for example, it will throw a StrictModeWiringException.

Returns:

this builder

wiringFactory

public RuntimeWiring.Builder wiringFactory(WiringFactory wiringFactory)

Adds a wiring factory into the runtime wiring

Parameters:

wiringFactory - the wiring factory to add

Returns:

this outer builder

codeRegistry

public RuntimeWiring.Builder codeRegistry(GraphQLCodeRegistry codeRegistry)

This allows you to seed in your own GraphQLCodeRegistry instance

Parameters:

codeRegistry - the code registry to use

Returns:

this outer builder

codeRegistry

public RuntimeWiring.Builder codeRegistry(GraphQLCodeRegistry.Builder codeRegistry)

This allows you to seed in your own GraphQLCodeRegistry instance

Parameters:

codeRegistry - the code registry to use

Returns:

this outer builder

scalar

public RuntimeWiring.Builder scalar(GraphQLScalarType scalarType)

This allows you to add in new custom Scalar implementations beyond the standard set.

Parameters:

scalarType - the new scalar implementation

Returns:

the runtime wiring builder

fieldVisibility

public RuntimeWiring.Builder fieldVisibility(GraphqlFieldVisibility fieldVisibility)

This allows you to add a field visibility that will be associated with the schema

Parameters:

fieldVisibility - the new field visibility

Returns:

the runtime wiring builder

type

public RuntimeWiring.Builder type(TypeRuntimeWiring.Builder builder)

This allows you to add a new type wiring via a builder

Parameters:

builder - the type wiring builder to use

Returns:

this outer builder

type

public RuntimeWiring.Builder type(String typeName,
 UnaryOperator<TypeRuntimeWiring.Builder> builderFunction)

This form allows a lambda to be used as the builder of a type wiring

Parameters:

typeName - the name of the type to wire

builderFunction - a function that will be given the builder to use

Returns:

the runtime wiring builder

type

public RuntimeWiring.Builder type(TypeRuntimeWiring typeRuntimeWiring)

This adds a type wiring

Parameters:

typeRuntimeWiring - the new type wiring

Returns:

the runtime wiring builder

directive

public RuntimeWiring.Builder directive(String directiveName,
 SchemaDirectiveWiring schemaDirectiveWiring)

This provides the wiring code for a named directive.

Note: The provided directive wiring will ONLY be called back if an element has a directive with the specified name.

To be called back for every directive the use directiveWiring(SchemaDirectiveWiring) or use WiringFactory.providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment) instead.

Parameters:

directiveName - the name of the directive to wire

schemaDirectiveWiring - the runtime behaviour of this wiring

Returns:

the runtime wiring builder

See Also:

• directiveWiring(SchemaDirectiveWiring)
• SchemaDirectiveWiring
• WiringFactory.providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment)

directiveWiring

public RuntimeWiring.Builder directiveWiring(SchemaDirectiveWiring schemaDirectiveWiring)

This adds a directive wiring that will be called for all directives.

Note : Unlike directive(String, SchemaDirectiveWiring) which is only called back if a named directives is present, this directive wiring will be called back for every element in the schema even if it has zero directives.

Parameters:

schemaDirectiveWiring - the runtime behaviour of this wiring

Returns:

the runtime wiring builder

See Also:

• directive(String, SchemaDirectiveWiring)
• SchemaDirectiveWiring
• WiringFactory.providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment)

comparatorRegistry

public RuntimeWiring.Builder comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry)

You can specify your own sort order of graphql types via GraphqlTypeComparatorRegistry which will tell you what type of objects you are to sort when it asks for a comparator.

Parameters:

comparatorRegistry - your own comparator registry

Returns:

the runtime wiring builder

build

public RuntimeWiring build()

Returns:

the built runtime wiring