Package graphql.scalar

Class GraphqlIDCoercing

java.lang.Object

graphql.scalar.GraphqlIDCoercing

All Implemented Interfaces:

Coercing<Object,Object>

public class GraphqlIDCoercing
extends Object
implements Coercing<Object,Object>

The deprecated methods still have implementations in case code outside graphql-java is calling them but internally the call paths have been replaced.

Constructor Summary

Constructors

Constructor	Description
GraphqlIDCoercing()

Method Summary

Modifier and Type	Method	Description
@Nullable Object	parseLiteral(@NonNull Value<?> input, @NonNull CoercedVariables variables, @NonNull GraphQLContext graphQLContext, @NonNull Locale locale)	Called during query execution to convert a query input AST node into a Java object acceptable for the scalar type.
String	parseLiteral(@NonNull Object input)	Deprecated.
String	parseValue(@NonNull Object input)	Deprecated.
Object	parseValue(@NonNull Object input, @NonNull GraphQLContext graphQLContext, @NonNull Locale locale)	Called to resolve an input from a query variable into a Java object acceptable for the scalar type.
String	serialize(@NonNull Object dataFetcherResult)	Deprecated.
@Nullable Object	serialize(@NonNull Object dataFetcherResult, @NonNull GraphQLContext graphQLContext, @NonNull Locale locale)	Called to convert a Java object result of a DataFetcher to a valid runtime value for the scalar type.
Value	valueToLiteral(@NonNull Object input)	Deprecated.
@NonNull Value<?>	valueToLiteral(@NonNull Object input, @NonNull GraphQLContext graphQLContext, @NonNull Locale locale)	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 Details

GraphqlIDCoercing

public GraphqlIDCoercing()

Method Details

serialize

@Deprecated
public String serialize(@NonNull Object dataFetcherResult)

Deprecated.

Description copied from interface: Coercing

This is deprecated and you should implement Coercing.serialize(Object, GraphQLContext, Locale) instead

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 serialization, 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<Object,Object>

Parameters:

dataFetcherResult - is never null

Returns:

a serialized value which may be null.

serialize

public @Nullable Object serialize(@NonNull Object dataFetcherResult,
 @NonNull GraphQLContext graphQLContext,
 @NonNull Locale locale)
                           throws CoercingSerializeException

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 serialization, 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<Object,Object>

Parameters:

dataFetcherResult - is never null

graphQLContext - the graphql context in place

locale - the locale to use

Returns:

a serialized value which may be null.

Throws:

CoercingSerializeException - if value input can't be serialized

parseValue

@Deprecated
public String parseValue(@NonNull Object input)

Deprecated.

Description copied from interface: Coercing

This is deprecated and you should implement Coercing.parseValue(Object, GraphQLContext, Locale) instead

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.

Note : if input is explicit/raw value null, input coercion will return null before this method is called

Specified by:

parseValue in interface Coercing<Object,Object>

Parameters:

input - is never null

Returns:

a parsed value which may be null

parseValue

public Object parseValue(@NonNull Object input,
 @NonNull GraphQLContext graphQLContext,
 @NonNull Locale locale)
                  throws CoercingParseValueException

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. Note : if input is explicit/raw value null, input coercion will return null before this method is called

Specified by:

parseValue in interface Coercing<Object,Object>

Parameters:

input - is never null

graphQLContext - the graphql context in place

locale - the locale to use

Returns:

a parsed value which may be null

Throws:

CoercingParseValueException - if value input can't be parsed

parseLiteral

@Deprecated
public String parseLiteral(@NonNull Object input)

Deprecated.

Description copied from interface: Coercing

This is deprecated and you should implement Coercing.parseLiteral(Value, CoercedVariables, GraphQLContext, Locale) instead

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.

Note : if input is literal NullValue, input coercion will return null before this method is called

Specified by:

parseLiteral in interface Coercing<Object,Object>

Parameters:

input - is never null

Returns:

a parsed value which may be null

parseLiteral

public @Nullable Object parseLiteral(@NonNull Value<?> input,
 @NonNull CoercedVariables variables,
 @NonNull GraphQLContext graphQLContext,
 @NonNull Locale locale)
                              throws CoercingParseLiteralException

Description copied from interface: Coercing

Called during query execution 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.

Many scalar types don't need to implement this method because they don't take AST VariableReference objects and convert them into actual values. But for those scalar types that want to do this, then this method should be implemented. Note : if input is literal NullValue, input coercion will return null before this method is called

Specified by:

parseLiteral in interface Coercing<Object,Object>

Parameters:

input - is never null

variables - the resolved variables passed to the query

graphQLContext - the graphql context in place

locale - the locale to use

Returns:

a parsed value which may be null

Throws:

CoercingParseLiteralException - if input literal can't be parsed

valueToLiteral

@Deprecated
public Value valueToLiteral(@NonNull Object input)

Deprecated.

Description copied from interface: Coercing

This is deprecated and you should implement Coercing.valueToLiteral(Object, GraphQLContext, Locale) instead

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<Object,Object>

Parameters:

input - an external input value

Returns:

The literal matching the external input value.

valueToLiteral

public @NonNull Value<?> valueToLiteral(@NonNull Object input,
 @NonNull GraphQLContext graphQLContext,
 @NonNull Locale locale)

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<Object,Object>

Parameters:

input - an external input value

graphQLContext - the graphql context in place

locale - the locale to use

Returns:

The literal matching the external input value.