graphql.schema

Class GraphQLScalarType

java.lang.Object

graphql.schema.GraphQLScalarType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputType, GraphQLNullableType, GraphQLOutputType, GraphQLType, GraphQLUnmodifiedType

public class GraphQLScalarType
extends java.lang.Object
implements GraphQLType, GraphQLInputType, GraphQLOutputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer

A scalar type is a leaf node in the graphql tree of types. This class allows you to define new scalar types.

GraphQL provides a number of built‐in scalars, but type systems can add additional scalars with semantic meaning, for example, a GraphQL system could define a scalar called Time which, while serialized as a string, promises to conform to ISO‐8601. When querying a field of type Time, you can then rely on the ability to parse the result with an ISO‐8601 parser and use a client‐specific primitive for time. From the spec : http://facebook.github.io/graphql/#sec-Scalars

graphql-java ships with a set of predefined scalar types via Scalars

See Also:

Scalars

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLScalarType.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLScalarType(java.lang.String name, java.lang.String description, Coercing coercing)
GraphQLScalarType(java.lang.String name, java.lang.String description, Coercing coercing, java.util.List<GraphQLDirective> directives, ScalarTypeDefinition definition)

Method Summary

Modifier and Type	Method and Description
Coercing	getCoercing()
ScalarTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.lang.String	getName()
static GraphQLScalarType.Builder	newScalar()
static GraphQLScalarType.Builder	newScalar(GraphQLScalarType existing)
java.lang.String	toString()
GraphQLScalarType	transform(java.util.function.Consumer<GraphQLScalarType.Builder> builderConsumer) This helps you transform the current GraphQLObjectType into another one by starting a builder with all the current values and allows you to transform it how you want.

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Constructor Detail

GraphQLScalarType

public GraphQLScalarType(java.lang.String name,
                         java.lang.String description,
                         Coercing coercing)

GraphQLScalarType

public GraphQLScalarType(java.lang.String name,
                         java.lang.String description,
                         Coercing coercing,
                         java.util.List<GraphQLDirective> directives,
                         ScalarTypeDefinition definition)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLType

Returns:

the name of the type which MUST fit within the regular expression [_A-Za-z][_0-9A-Za-z]*

getDescription

public java.lang.String getDescription()

getCoercing

public Coercing getCoercing()

getDefinition

public ScalarTypeDefinition getDefinition()

getDirectives

public java.util.List<GraphQLDirective> getDirectives()

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transform

public GraphQLScalarType transform(java.util.function.Consumer<GraphQLScalarType.Builder> builderConsumer)

This helps you transform the current GraphQLObjectType into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new object based on calling build on that builder

newScalar

public static GraphQLScalarType.Builder newScalar()

newScalar

public static GraphQLScalarType.Builder newScalar(GraphQLScalarType existing)