com.graphql_java_generator.client

Class GraphqlClientUtils

java.lang.Object

com.graphql_java_generator.client.GraphqlClientUtils

@Component
public class GraphqlClientUtils
extends Object

Author:

EtienneSF

Constructor Summary

Constructors

Constructor and Description
GraphqlClientUtils()

Method Summary

Modifier and Type	Method and Description
Class<?>	checkFieldOfGraphQLType(String name, Boolean shouldBeScalar, Class<?> owningClass) Check if the given field is owned by the class of this ObjectResponse.
Class<?>	checkIsScalar(Field field, Boolean shouldBeScalar) This method checks whether the given field (as an attribute) of the given class is a GraphQL scalar, or not, depending on shouldBeScalar.
Class<?>	checkIsScalar(String fieldName, Method method, Boolean shouldBeScalar) This method checks whether the given field (as a method: getter, query...) of the given class is a GraphQL scalar, or not, depending on shouldBeScalar.
void	checkName(String graphqlIdentifier) Checks that the given GraphQL name is valid.
Map<String,Object>	generatesBindVariableValuesMap(Object[] paramsAndValues) This method retrieves the couple of name and values given in these parameters, stores them in a map where the key is the param name, and the value is the value of the Map.
Class<?>	getGraphQLType(AccessibleObject fieldOrMethod) Returns the Class indicated as the value for the graphqlType attribute of the GraphQLScalar or GraphQLNonScalar annotation
boolean	isScalar(AccessibleObject fieldOrMethod) Indicates whether the given class is a scalar or not

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphqlClientUtils

public GraphqlClientUtils()

Method Detail

checkName

public void checkName(String graphqlIdentifier)
               throws GraphQLRequestPreparationException

Checks that the given GraphQL name is valid.

Parameters:

graphqlIdentifier -

Throws:

NullPointerException - If name is null

GraphQLRequestPreparationException - If the given graphqlIdentifier is not a valid identifier

checkIsScalar

public Class<?> checkIsScalar(Field field,
                              Boolean shouldBeScalar)
                       throws GraphQLRequestPreparationException

This method checks whether the given field (as an attribute) of the given class is a GraphQL scalar, or not, depending on shouldBeScalar.

Parameters:

field - The field whose type should be (or not) a scalar

shouldBeScalar - if true, this method checks that field's type is a scalar (if false, checks that it is not a scalar)

Throws:

GraphQLRequestPreparationException

checkIsScalar

public Class<?> checkIsScalar(String fieldName,
                              Method method,
                              Boolean shouldBeScalar)
                       throws GraphQLRequestPreparationException

This method checks whether the given field (as a method: getter, query...) of the given class is a GraphQL scalar, or not, depending on shouldBeScalar.

Parameters:

fieldName - the name of the field represented by the given method.

method - The method whose return should be (or not) a scalar. This method can be a setter, a getter (in which case its name is different from the fieldName), or a query/mutation/subscription (in which case its name is the fieldName)

shouldBeScalar - if true, this method checks that method return type is a scalar (if false, checks that it is not a scalar)

Throws:

GraphQLRequestPreparationException

isScalar

public boolean isScalar(AccessibleObject fieldOrMethod)
                 throws GraphQLRequestPreparationException

Indicates whether the given class is a scalar or not

Parameters:

fieldOrMethod -

Returns:

true if clazz is a scalar type

Throws:

GraphQLRequestPreparationException

getGraphQLType

public Class<?> getGraphQLType(AccessibleObject fieldOrMethod)
                        throws GraphQLRequestPreparationException

Returns the Class indicated as the value for the graphqlType attribute of the GraphQLScalar or GraphQLNonScalar annotation

Parameters:

fieldOrMethod -

Returns:

Throws:

GraphQLRequestPreparationException

checkFieldOfGraphQLType

public Class<?> checkFieldOfGraphQLType(String name,
                                        Boolean shouldBeScalar,
                                        Class<?> owningClass)
                                 throws GraphQLRequestPreparationException

Check if the given field is owned by the class of this ObjectResponse. This method returns the class for this field.

Parameters:

name - The name of the field we want to check

shouldBeScalar - if true: also checks that the field is a scalar (throws a GraphQLRequestPreparationException if not). If false: also checks that the field is not a scalar (throws a GraphQLRequestPreparationException if not). If null: no check whether the field is a scalar or not

owningClass - The class in which will search for name as a GraphQL field

Returns:

the class of this field

Throws:

NullPointerException - if name is null

GraphQLRequestPreparationException - if the check is KO

generatesBindVariableValuesMap

public Map<String,Object> generatesBindVariableValuesMap(Object[] paramsAndValues)
                                                  throws GraphQLRequestExecutionException,
                                                         ClassCastException

This method retrieves the couple of name and values given in these parameters, stores them in a map where the key is the param name, and the value is the value of the Map.

Parameters:

paramsAndValues - A series of name and values : (paramName1, paramValue1, paramName2, paramValue2...). So there must be an even number of items in this array. Empty arrays are allowed (that is no parameter name and value).
This series is sent by the developer's code, when it calls the request methods.

Returns:

The map with paramName1, paramName2 (...) are the keys, and paramValue1, paramValue2 (...) are the associated content.

Throws:

GraphQLRequestExecutionException - When a non-even number of parameters is sent to this method

ClassCastException - When a parameter name is not a String