graphql.schema

Class GraphQLScalarType

java.lang.Object

graphql.schema.GraphQLScalarType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputType, GraphQLNamedInputType, GraphQLNamedOutputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLScalarType
extends java.lang.Object
implements GraphQLNamedInputType, GraphQLNamedOutputType, 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_DIRECTIVES

Constructor Summary

Constructors

Constructor and Description
GraphQLScalarType(java.lang.String name, java.lang.String description, Coercing coercing) Deprecated. use the newScalar() builder pattern instead, as this constructor will be made private in a future version.
GraphQLScalarType(java.lang.String name, java.lang.String description, Coercing coercing, java.util.List<GraphQLDirective> directives, ScalarTypeDefinition definition) Deprecated. use the newScalar() builder pattern instead, as this constructor will be made private in a future version.

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
boolean	equals(java.lang.Object o) No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
java.util.Map<java.lang.String,java.util.List<GraphQLDirective>>	getAllDirectivesByName() This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
Coercing	getCoercing()
ScalarTypeDefinition	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDescription()
GraphQLDirective	getDirective(java.lang.String directiveName) Returns a non repeatable directive with the provided name.
java.util.List<GraphQLDirective>	getDirectives() This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non repeatable directives.
java.util.Map<java.lang.String,GraphQLDirective>	getDirectivesByName() This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement.
java.util.List<ScalarTypeExtensionDefinition>	getExtensionDefinitions()
java.lang.String	getName()
java.lang.String	getSpecifiedByUrl()
int	hashCode() No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
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.
GraphQLScalarType	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirectives

Field Detail

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

Constructor Detail

GraphQLScalarType

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

Deprecated. use the newScalar() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

coercing - the coercing function

GraphQLScalarType

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

Deprecated. use the newScalar() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

coercing - the coercing function

directives - the directives on this type element

definition - the AST definition

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getSpecifiedByUrl

public java.lang.String getSpecifiedByUrl()

getCoercing

public Coercing getCoercing()

getDefinition

public ScalarTypeDefinition getDefinition()

Description copied from interface: GraphQLNamedSchemaElement

The AST Node this schema element is based on. Is null if the GraphQLSchema is not based on a SDL document. Some elements also have additional extension Nodes. See for example GraphQLObjectType.getExtensionDefinitions()

Specified by:

getDefinition in interface GraphQLNamedSchemaElement

Returns:

Node which this element is based on. Can be null.

getExtensionDefinitions

public java.util.List<ScalarTypeExtensionDefinition> getExtensionDefinitions()

getDirectives

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

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non repeatable directives.

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getDirectivesByName

public java.util.Map<java.lang.String,GraphQLDirective> getDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement. Any repeatable directives will be filtered out of this map.

Specified by:

getDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of non repeatable directives by directive name.

getAllDirectivesByName

public java.util.Map<java.lang.String,java.util.List<GraphQLDirective>> getAllDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.

Specified by:

getAllDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getDirective

public GraphQLDirective getDirective(java.lang.String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non repeatable directive with the provided name. This will throw a AssertException if the directive is a repeatable directive that has more then one instance.

Specified by:

getDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

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

accept

public TraversalControl accept(TraverserContext<GraphQLSchemaElement> context,
                               GraphQLTypeVisitor visitor)

Specified by:

accept in interface GraphQLSchemaElement

getChildren

public java.util.List<GraphQLSchemaElement> getChildren()

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLScalarType withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

equals

public final boolean equals(java.lang.Object o)

No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

equals in interface GraphQLSchemaElement

Overrides:

equals in class java.lang.Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public final int hashCode()

No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

hashCode in interface GraphQLSchemaElement

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

newScalar

public static GraphQLScalarType.Builder newScalar()

newScalar

public static GraphQLScalarType.Builder newScalar(GraphQLScalarType existing)