graphql.scalar

Class GraphqlIDCoercing

java.lang.Object

graphql.scalar.GraphqlIDCoercing

All Implemented Interfaces:

Coercing<java.lang.Object,java.lang.Object>

public class GraphqlIDCoercing
extends java.lang.Object
implements Coercing<java.lang.Object,java.lang.Object>

Constructor Summary

Constructors

Constructor and Description
GraphqlIDCoercing()

Method Summary

Modifier and Type	Method and Description
java.lang.String	parseLiteral(java.lang.Object input) Called during query validation to convert a query input AST node into a Java object acceptable for the scalar type.
java.lang.String	parseValue(java.lang.Object input) Called to resolve an input from a query variable into a Java object acceptable for the scalar type.
java.lang.String	serialize(java.lang.Object input) Called to convert a Java object result of a DataFetcher to a valid runtime value for the scalar type.
Value	valueToLiteral(java.lang.Object input) Converts an external input value to a literal (Ast Value).

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.schema.Coercing

parseLiteral

Constructor Detail

GraphqlIDCoercing

public GraphqlIDCoercing()

Method Detail

serialize

public java.lang.String serialize(java.lang.Object input)

Description copied from interface: Coercing

Called to convert a Java object result of a DataFetcher to a valid runtime value for the scalar type.

Note : Throw CoercingSerializeException if there is fundamental problem during serialisation, don't return null to indicate failure.

Note : You should not allow RuntimeExceptions to come out of your serialize method, but rather catch them and fire them as CoercingSerializeException instead as per the method contract.

Specified by:

serialize in interface Coercing<java.lang.Object,java.lang.Object>

Parameters:

input - is never null

Returns:

a serialized value which may be null.

parseValue

public java.lang.String parseValue(java.lang.Object input)

Description copied from interface: Coercing

Called to resolve an input from a query variable into a Java object acceptable for the scalar type.

Note : You should not allow RuntimeExceptions to come out of your parseValue method, but rather catch them and fire them as CoercingParseValueException instead as per the method contract.

Specified by:

parseValue in interface Coercing<java.lang.Object,java.lang.Object>

Parameters:

input - is never null

Returns:

a parsed value which is never null

parseLiteral

public java.lang.String parseLiteral(java.lang.Object input)

Description copied from interface: Coercing

Called during query validation to convert a query input AST node into a Java object acceptable for the scalar type. The input object will be an instance of Value.

Note : You should not allow RuntimeExceptions to come out of your parseLiteral method, but rather catch them and fire them as CoercingParseLiteralException instead as per the method contract.

Specified by:

parseLiteral in interface Coercing<java.lang.Object,java.lang.Object>

Parameters:

input - is never null

Returns:

a parsed value which is never null

valueToLiteral

public Value valueToLiteral(java.lang.Object input)

Description copied from interface: Coercing

Converts an external input value to a literal (Ast Value). IMPORTANT: the argument is validated before by calling Coercing.parseValue(Object).

Specified by:

valueToLiteral in interface Coercing<java.lang.Object,java.lang.Object>

Parameters:

input - an external input value

Returns:

The literal matching the external input value.