net.morimekta.providence.graphql

Class GQLDefinition.Builder

java.lang.Object

net.morimekta.providence.graphql.GQLDefinition.Builder

Enclosing class:

GQLDefinition

public static class GQLDefinition.Builder
extends Object

Builder for setting up a GraphQL definition.

Method Summary

Modifier and Type	Method and Description
GQLDefinition.Builder	asInterface(net.morimekta.providence.descriptor.PUnionDescriptor<?>... descriptors) Handle these unions as interfaces.
GQLDefinition	build() Build the GraphQL definition.
GQLDefinition.Builder	idField(net.morimekta.providence.descriptor.PField<?>... fields) Transform field from string, binary or container of string or binary to ID or ID list.
GQLDefinition.Builder	ignoreFields(net.morimekta.providence.descriptor.PField<?>... fields) Skip these fields.
GQLDefinition.Builder	ignoreMaps() Just ignore all maps, instead of failing.
GQLDefinition.Builder	ignoreTypes(net.morimekta.providence.descriptor.PDeclaredDescriptor<?>... types) Setting this will ignore all fields of the given type, or containing the given type (list, set, map).
GQLDefinition.Builder	mutation(net.morimekta.providence.descriptor.PService mutation) Service used for handling queries.
GQLDefinition.Builder	query(net.morimekta.providence.descriptor.PService query) Service used for handling queries.

Methods inherited from class java.lang.Object

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

Method Detail

query

public GQLDefinition.Builder query(net.morimekta.providence.descriptor.PService query)

Service used for handling queries.

Parameters:

query - The query service.

Returns:

The builder.

mutation

public GQLDefinition.Builder mutation(net.morimekta.providence.descriptor.PService mutation)

Service used for handling queries.

Parameters:

mutation - The mutation service.

Returns:

The builder.

idField

public GQLDefinition.Builder idField(net.morimekta.providence.descriptor.PField<?>... fields)

Transform field from string, binary or container of string or binary to ID or ID list.

Parameters:

fields - The fields to be made into ID fields.

Returns:

The builder.

asInterface

public GQLDefinition.Builder asInterface(net.morimekta.providence.descriptor.PUnionDescriptor<?>... descriptors)

Handle these unions as interfaces. The union will be ignored in the schema (except for input types), and it's interface will be used instead.

Parameters:

descriptors - Union descriptors to handle as interfaces.

Returns:

The builder.

ignoreMaps

public GQLDefinition.Builder ignoreMaps()

Just ignore all maps, instead of failing.

Returns:

The builder.

ignoreFields

public GQLDefinition.Builder ignoreFields(net.morimekta.providence.descriptor.PField<?>... fields)

Skip these fields. It will be possible to select / reference the field, but it will be skipped from the schema.

Parameters:

fields - The fields to be ignore / skipped.

Returns:

The builder.

ignoreTypes

public GQLDefinition.Builder ignoreTypes(net.morimekta.providence.descriptor.PDeclaredDescriptor<?>... types)

Setting this will ignore all fields of the given type, or containing the given type (list, set, map). Only declared types can be ignored.

Parameters:

types - Types to be ignored.

Returns:

The builder.

build

public GQLDefinition build()

Build the GraphQL definition.

Returns:

The GQL definition.