Index
A B C D E G I J L M N O P Q R S T V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCustomScalarDeserializer<T> - Class in com.graphql_java_generator.client.response
-
Jackson Deserializer for Custom Scalar.
- AbstractCustomScalarDeserializer(Class<?>, GraphQLScalarType) - Constructor for class com.graphql_java_generator.client.response.AbstractCustomScalarDeserializer
- addInputParameter(InputParameter) - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Add an
InputParameter
to this object. - addInputParameters(List<InputParameter>) - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Add a list of
InputParameter
s to this object. - appendResponseQuery(StringBuilder, Map<String, Object>, boolean) - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the part of the query, which describes the fields that the GraphQL server should return.
For instance, for the query: {hero(episode: NEWHOPE) {id name}}, the response definition is {id name}
B
- build() - Method in class com.graphql_java_generator.client.request.Builder
-
Returns the built
ObjectResponse
. - Builder - Class in com.graphql_java_generator.client.request
-
This class is a Builder that'll help to build a
ObjectResponse
, which defines what should appear in the response from the GraphQL server. - Builder(Class<?>, String) - Constructor for class com.graphql_java_generator.client.request.Builder
-
Creates a Builder, for a field without alias
- Builder(Class<?>, String, String) - Constructor for class com.graphql_java_generator.client.request.Builder
-
Creates a Builder
C
- checkFieldOfGraphQLType(String, Boolean, Class<?>) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
Check if the given field is owned by the class of this
ObjectResponse
. - checkIsScalar(Field, Boolean) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
This method checks whether the given field (as an attribute) of the given class is a GraphQL scalar, or not, depending on shouldBeScalar.
- checkIsScalar(String, Method, Boolean) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
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.
- checkName(String) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
Checks that the given GraphQL name is valid.
- code - Variable in class com.graphql_java_generator.client.response.Extension
- column - Variable in class com.graphql_java_generator.client.response.Location
- com.graphql_java_generator - package com.graphql_java_generator
- com.graphql_java_generator.annotation - package com.graphql_java_generator.annotation
-
All annotations used by the GraphQL-generator client part
- com.graphql_java_generator.client - package com.graphql_java_generator.client
- com.graphql_java_generator.client.request - package com.graphql_java_generator.client.request
-
This package contains all the classes used to generate the requests toward the GraphQL server.
- com.graphql_java_generator.client.response - package com.graphql_java_generator.client.response
-
All classes about the management of the response, coming from the GraphQL server
- com.graphql_java_generator.customscalars - package com.graphql_java_generator.customscalars
-
This package provide "as is" some
GraphQLScalarType
s. - com.graphql_java_generator.exception - package com.graphql_java_generator.exception
- customScalarRegistry - Static variable in class com.graphql_java_generator.CustomScalarRegistryImpl
-
As we may have or not have Spring at runtime, we manually manage a singleton.
- CustomScalarRegistry - Interface in com.graphql_java_generator
-
Registry for all
GraphQLScalarType
available. - CustomScalarRegistryImpl - Class in com.graphql_java_generator
- CustomScalarRegistryImpl() - Constructor for class com.graphql_java_generator.CustomScalarRegistryImpl
D
- data - Variable in class com.graphql_java_generator.client.response.JsonResponseWrapper
-
This contains the data coming from the GraphQL part.
- description - Variable in class com.graphql_java_generator.client.response.Error
- deserialize(JsonParser, DeserializationContext) - Method in class com.graphql_java_generator.client.response.AbstractCustomScalarDeserializer
E
- Error - Class in com.graphql_java_generator.client.response
-
The error POJO, mapped from the GraphQL server response, when an error occurs
- Error() - Constructor for class com.graphql_java_generator.client.response.Error
- errors - Variable in class com.graphql_java_generator.client.response.JsonResponseWrapper
- errorType - Variable in class com.graphql_java_generator.client.response.Error
- execute(String, ObjectResponse, Map<String, Object>, Class<T>) - Method in interface com.graphql_java_generator.client.QueryExecutor
-
Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.
- execute(String, ObjectResponse, Map<String, Object>, Class<T>) - Method in class com.graphql_java_generator.client.QueryExecutorImpl
-
Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.
- execute(String, Class<T>) - Method in interface com.graphql_java_generator.client.QueryExecutor
-
Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.
- execute(String, Class<T>) - Method in class com.graphql_java_generator.client.QueryExecutorImpl
-
Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.
- Extension - Class in com.graphql_java_generator.client.response
- Extension() - Constructor for class com.graphql_java_generator.client.response.Extension
- extensions - Variable in class com.graphql_java_generator.client.response.Error
G
- generatesBindVariableValuesMap(Object[]) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
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
. - getCamelCase(String) - Static method in class com.graphql_java_generator.client.request.Builder
-
Convert the given name, to a camel case name.
- getFieldAlias() - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the alias for the field, which response is defined by this instance
- getFieldClass() - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the class for the field, which response is defined by this instance
- getFieldName() - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the name for the field, which response is defined by this instance
- getGetter(Class<T>, Field) - Method in class com.graphql_java_generator.GraphqlUtils
-
Retrieves the getter for the given field on the given field
- getGraphQLScalarType(String) - Method in interface com.graphql_java_generator.CustomScalarRegistry
-
Retrieves the registered
GraphQLScalarType
for this GraphQL CustomScalar. - getGraphQLScalarType(String) - Method in class com.graphql_java_generator.CustomScalarRegistryImpl
-
Retrieves the registered
GraphQLScalarType
for this GraphQL CustomScalar. - getGraphQLType(AccessibleObject) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
Returns the Class indicated as the value for the graphqlType attribute of the GraphQLScalar or GraphQLNonScalar annotation
- getInputObject(Map<String, Object>, Class<T>) - Method in class com.graphql_java_generator.GraphqlUtils
-
This method returns a GraphQL input object, as defined in the GraphQL schema, from the Map that has been read from the JSON object sent to the server.
- getInputParameters() - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the
InputParameter
for the field, which response is defined by this instance - getJavaName(String) - Method in class com.graphql_java_generator.GraphqlUtils
-
Returns a valid java identifier for the given name.
- getListInputObjects(List<Map<String, Object>>, Class<T>) - Method in class com.graphql_java_generator.GraphqlUtils
-
This method returns a list of instances of the given class, from a list of
Map
. - getMethod(String, Class<?>, Class<?>...) - Method in class com.graphql_java_generator.GraphqlUtils
-
Retrieves the asked method, from its name, class and parameters.
- getName() - Method in class com.graphql_java_generator.client.request.InputParameter
- getOwningClass() - Method in class com.graphql_java_generator.client.request.ObjectResponse
-
Retrieves the GraphQL type that owns the field, which response is defined by this instance
- getPascalCase(String) - Method in class com.graphql_java_generator.GraphqlUtils
-
Returns the given name in PascalCase.
- getSetter(Class<T>, Field) - Method in class com.graphql_java_generator.GraphqlUtils
-
Retrieves the setter for the given field on the given field
- getValue() - Method in class com.graphql_java_generator.client.request.InputParameter
- getValueForGraphqlQuery(Map<String, Object>) - Method in class com.graphql_java_generator.client.request.InputParameter
-
Returns the parameter, as it should be written in the GraphQL query.
- GRAPHQL_MARKER - Static variable in interface com.graphql_java_generator.client.QueryExecutor
- GRAPHQL_MUTATION_MARKER - Static variable in interface com.graphql_java_generator.client.QueryExecutor
- GRAPHQL_QUERY_MARKER - Static variable in interface com.graphql_java_generator.client.QueryExecutor
- GRAPHQL_SUBSCRIPTION_MARKER - Static variable in interface com.graphql_java_generator.client.QueryExecutor
- GraphqlClientUtils - Class in com.graphql_java_generator.client
- GraphqlClientUtils() - Constructor for class com.graphql_java_generator.client.GraphqlClientUtils
- GraphQLCustomScalar - Annotation Type in com.graphql_java_generator.annotation
-
This annotation marks all fields in the generated classes, that are GraphQL Custom Scalar.
- GraphQLInputParameters - Annotation Type in com.graphql_java_generator.annotation
-
This class indicates that this field has at least one input parameter.
- GraphQLInputType - Annotation Type in com.graphql_java_generator.annotation
-
This annotation marks all generated classes that are generated to match a GraphQL input type, as defined in the GraphQL schema
- GraphQLInternalErrorException - Exception in com.graphql_java_generator.exception
-
Thrown when an internal error of the GraphQL generator occurs
- GraphQLInternalErrorException(String) - Constructor for exception com.graphql_java_generator.exception.GraphQLInternalErrorException
- GraphQLInternalErrorException(String, Throwable) - Constructor for exception com.graphql_java_generator.exception.GraphQLInternalErrorException
- GraphQLNonScalar - Annotation Type in com.graphql_java_generator.annotation
-
This annotation marks all fields in the generated classes, that are non scalar.
- GraphQLQuery - Annotation Type in com.graphql_java_generator.annotation
-
This annotation marks all generated classes that are queries/mutations/subscription, as defined in the GraphQL schema.
- GraphQLRequestExecutionException - Exception in com.graphql_java_generator.exception
-
Thrown when an error occurs during the request execution.
- GraphQLRequestExecutionException(String) - Constructor for exception com.graphql_java_generator.exception.GraphQLRequestExecutionException
- GraphQLRequestExecutionException(String, Throwable) - Constructor for exception com.graphql_java_generator.exception.GraphQLRequestExecutionException
- GraphQLRequestPreparationException - Exception in com.graphql_java_generator.exception
-
Thrown when an error occurs during the request preparation.
- GraphQLRequestPreparationException(String) - Constructor for exception com.graphql_java_generator.exception.GraphQLRequestPreparationException
- GraphQLRequestPreparationException(String, Throwable) - Constructor for exception com.graphql_java_generator.exception.GraphQLRequestPreparationException
- GraphQLResponseParseException - Exception in com.graphql_java_generator.exception
-
Thrown when the client could not parse the GraphQL response.
- GraphQLResponseParseException(String) - Constructor for exception com.graphql_java_generator.exception.GraphQLResponseParseException
- GraphQLResponseParseException(String, Throwable) - Constructor for exception com.graphql_java_generator.exception.GraphQLResponseParseException
- GraphQLScalar - Annotation Type in com.graphql_java_generator.annotation
-
This annotation marks all fields in the generated classes, that are standard GraphQL scalar.
- GraphQLScalarTypeDate - Class in com.graphql_java_generator.customscalars
-
A proposed Date scalar, that stores dates in String, formatted as: YYYY-MM-DD
This Scalar is proposed to be used, for integration testing (checks that the plugin correctly manages Custom Scalars, see samples) and with more documentation to help people to create their own Custom Scalar implementations. - GraphQLScalarTypeDate() - Constructor for class com.graphql_java_generator.customscalars.GraphQLScalarTypeDate
-
As the constructors for the
GraphQLScalarType
are marked as deprecated, the way to create Custom Scalars may change in the future. - GraphQLScalarTypeDateTime - Class in com.graphql_java_generator.customscalars
-
A proposed DateTime scalar, that stores dates in String, formatted as: 2019-07-03T20:47:55Z
This Scalar is proposed to be used, for integration testing (checks that the plugin correctly manages Custom Scalars, see samples) and with more documentation to help people to create their own Custom Scalar implementations. - GraphQLScalarTypeDateTime() - Constructor for class com.graphql_java_generator.customscalars.GraphQLScalarTypeDateTime
-
As the constructors for the
GraphQLScalarType
are marked as deprecated, the way to create Custom Scalars may change in the future. - GraphQLScalarTypeString - Class in com.graphql_java_generator.customscalars
-
Useless String scalar.
It's used both as a sample, to be completed by a developper, according to his/her needs, and for the use in some tests of the plugin logic (like in the Shopify sample, to handle (badly) various scalar as based on strings).
It's actually a bad management, as this custom scalars does nothing, but read basic strings. - GraphQLScalarTypeString() - Constructor for class com.graphql_java_generator.customscalars.GraphQLScalarTypeString
-
As the constructors for the
GraphQLScalarType
are marked as deprecated, the way to create Custom Scalars may change in the future. - graphQLTypeName() - Method in annotation type com.graphql_java_generator.annotation.GraphQLCustomScalar
-
The name of the Custom Scalar type, as defined in the GraphQL schema.
- graphQLTypeName() - Method in annotation type com.graphql_java_generator.annotation.GraphQLNonScalar
-
The name of the Custom Scalar type, as defined in the GraphQL schema.
- graphQLTypeName() - Method in annotation type com.graphql_java_generator.annotation.GraphQLScalar
-
The name of the Custom Scalar type, as defined in the GraphQL schema.
- graphqlUtils - Static variable in class com.graphql_java_generator.GraphqlUtils
-
This singleton is usable in default method, within interfaces
- GraphqlUtils - Class in com.graphql_java_generator
- GraphqlUtils() - Constructor for class com.graphql_java_generator.GraphqlUtils
I
- InputParameter - Class in com.graphql_java_generator.client.request
-
Contains an input parameter, to be sent to a query (mutation...).
- invokeGetter(Object, String) - Method in class com.graphql_java_generator.GraphqlUtils
-
Invoke the getter for the given field name, on the given object.
- invokeMethod(Method, Object, Object...) - Method in class com.graphql_java_generator.GraphqlUtils
-
Invoke the given setter on the given object, with the given value.
- invokeSetter(Object, Field, Object) - Method in class com.graphql_java_generator.GraphqlUtils
-
Invoke the setter for the given field, on the given object.
- invokeSetter(Object, String, Object) - Method in class com.graphql_java_generator.GraphqlUtils
-
Invoke the setter for the
Field
of the given name, on the given object. - isJavaReservedWords(String) - Method in class com.graphql_java_generator.GraphqlUtils
-
Returns true if name is a reserved java keyword
- isScalar(AccessibleObject) - Method in class com.graphql_java_generator.client.GraphqlClientUtils
-
Indicates whether the given class is a scalar or not
J
- JAVA_KEYWORD_PREFIX - Static variable in class com.graphql_java_generator.GraphqlUtils
- javaClass() - Method in annotation type com.graphql_java_generator.annotation.GraphQLCustomScalar
-
Contains the java data type that is has used to store the data, on both the client and the server side.
- javaClass() - Method in annotation type com.graphql_java_generator.annotation.GraphQLNonScalar
-
Contains the java data type that is has used to store the data, on both the client and the server side.
- javaClass() - Method in annotation type com.graphql_java_generator.annotation.GraphQLScalar
-
Contains the java data type that is has used to store the data, on both the client and the server side.
- JsonResponseWrapper - Class in com.graphql_java_generator.client.response
- JsonResponseWrapper() - Constructor for class com.graphql_java_generator.client.response.JsonResponseWrapper
L
- line - Variable in class com.graphql_java_generator.client.response.Location
- Location - Class in com.graphql_java_generator.client.response
- Location() - Constructor for class com.graphql_java_generator.client.response.Location
- locations - Variable in class com.graphql_java_generator.client.response.Error
M
N
- names() - Method in annotation type com.graphql_java_generator.annotation.GraphQLInputParameters
-
Contains the list of the names for each of the input parameters of this field.
- newBindParameter(String, String, boolean) - Static method in class com.graphql_java_generator.client.request.InputParameter
-
Deprecated.
- newBindParameter(String, String, boolean, GraphQLScalarType) - Static method in class com.graphql_java_generator.client.request.InputParameter
-
Deprecated.
- newHardCodedParameter(String, Object) - Static method in class com.graphql_java_generator.client.request.InputParameter
-
Deprecated.
O
- ObjectResponse - Class in com.graphql_java_generator.client.request
-
This class describes what response is expected from the GraphQL server.
P
Q
- QueryExecutor - Interface in com.graphql_java_generator.client
-
This class is the query executor : a generic class, reponsible for calling the GraphQL server, and return its response as POJOs.
- QueryExecutorImpl - Class in com.graphql_java_generator.client
-
This class is the query executor : a generic class, reponsible for calling the GraphQL server, for query, mutation and subscription.
It has one major parameter: the GraphQL endpoint. - QueryExecutorImpl(String) - Constructor for class com.graphql_java_generator.client.QueryExecutorImpl
-
This constructor expects the URI of the GraphQL server
For example: http://my.server.com/graphql or https://my.server.com/graphql - QueryExecutorImpl(String, SSLContext, HostnameVerifier) - Constructor for class com.graphql_java_generator.client.QueryExecutorImpl
-
This constructor expects the URI of the GraphQL server.
- QueryExecutorImpl(String, Client, ObjectMapper) - Constructor for class com.graphql_java_generator.client.QueryExecutorImpl
-
This constructor expects the URI of the GraphQL server and a configured JAX-RS client that gives the opportunity to customise the REST request
For example: http://my.server.com/graphql - queryPath - Variable in class com.graphql_java_generator.client.response.Error
R
- registerAllGraphQLScalarType() - Method in interface com.graphql_java_generator.CustomScalarRegistry
-
This method registers all
GraphQLScalarType
that are declared as SpringComponent
. - registerAllGraphQLScalarType() - Method in class com.graphql_java_generator.CustomScalarRegistryImpl
-
This method registers all
GraphQLScalarType
that are declared as SpringComponent
. - registerGraphQLScalarType(GraphQLScalarType) - Method in interface com.graphql_java_generator.CustomScalarRegistry
-
Manually register one
GraphQLScalarType
. - registerGraphQLScalarType(GraphQLScalarType) - Method in class com.graphql_java_generator.CustomScalarRegistryImpl
-
Manually register one
GraphQLScalarType
.
S
- sourceName - Variable in class com.graphql_java_generator.client.response.Location
T
- timestamp - Variable in class com.graphql_java_generator.client.response.Extension
- toString() - Method in class com.graphql_java_generator.client.response.Error
-
Logs this error to the given
Logger
- toString() - Method in class com.graphql_java_generator.client.response.Location
- types() - Method in annotation type com.graphql_java_generator.annotation.GraphQLInputParameters
-
Contains the list of the types for each of the input parameters of this field.
V
- validationErrorType - Variable in class com.graphql_java_generator.client.response.Error
W
- withField(String) - Method in class com.graphql_java_generator.client.request.Builder
-
Adds a scalar field with no alias, to the
ObjectResponse
we are building - withField(String, String) - Method in class com.graphql_java_generator.client.request.Builder
-
Adds a scalar field with an alias, to the
ObjectResponse
we are building. - withField(String, String, List<InputParameter>) - Method in class com.graphql_java_generator.client.request.Builder
-
Adds a scalar field with an alias, to the
ObjectResponse
we are building. - withInputParameter(InputParameter) - Method in class com.graphql_java_generator.client.request.Builder
-
Deprecated.
- withInputParameter(String, String, boolean) - Method in class com.graphql_java_generator.client.request.Builder
-
Add an
InputParameter
to the current Object Response definition. - withInputParameterHardCoded(String, Object) - Method in class com.graphql_java_generator.client.request.Builder
-
Add an
InputParameter
to the current Object Response definition. - withInputParameters(List<InputParameter>) - Method in class com.graphql_java_generator.client.request.Builder
-
Add a list of
InputParameter
s to the current Object Response definition. - withQueryResponseDef(String) - Method in class com.graphql_java_generator.client.request.Builder
-
Builds a
ObjectResponse
from a part of a GraphQL query. - withSubObject(ObjectResponse) - Method in class com.graphql_java_generator.client.request.Builder
-
Adds a non scalar field (a sub-object), to the
ObjectResponse
we are building.
All Classes All Packages