Package com.graphql_java_generator.plugin.conf

Interface GenerateClientCodeConfiguration

All Superinterfaces:

CommonConfiguration, GenerateCodeCommonConfiguration

All Known Subinterfaces:

GeneratePojoConfiguration, GraphQLConfiguration

public interface GenerateClientCodeConfiguration
extends GenerateCodeCommonConfiguration

This class contains all parameters for the generateClientCode goal/task.

Author:

etienne-sf

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GENERATE_DEPRECATED_REQUEST_RESPONSE

Fields inherited from interface com.graphql_java_generator.plugin.conf.CommonConfiguration

DEFAULT_ADD_RELAY_CONNECTIONS, DEFAULT_JSON_GRAPHQL_SCHEMA_FILE, DEFAULT_MAX_TOKENS, DEFAULT_PACKAGE_NAME, DEFAULT_PREFIX, DEFAULT_SCHEMA_FILE_FOLDER, DEFAULT_SCHEMA_FILE_PATTERN, DEFAULT_SCHEMA_SUB_FOLDER, DEFAULT_SKIP_GENERATION_IF_SCHEMA_HAS_NOT_CHANGED, DEFAULT_SUFFIX

Fields inherited from interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

DEFAULT_COPY_RUNTIME_SOURCES, DEFAULT_QUERY_MUTATION_EXECUTION_PROTOCOL, DEFAULT_SCHEMA_PERSONALIZATION_FILE, DEFAULT_SEPARATE_UTIL_CLASSES, DEFAULT_SOURCE_ENCODING, DEFAULT_SPRING_BEAN_SUFFIX, DEFAULT_TARGET_RESOURCE_FOLDER, DEFAULT_TARGET_SOURCE_FOLDER, DEFAULT_USE_JAKARTA_EE9

Method Summary

Modifier and Type	Method	Description
boolean	isGenerateDeprecatedRequestResponse()	(since 1.7.1 version) Default value is _true_ for 1.x version, and _false_ for version 2.0 and after.
default boolean	isGenerateJacksonAnnotations()	This method is used only in GeneratePojoConfiguration.
default void	logConfiguration()	Logs all the configuration parameters (only when in the debug level)

Methods inherited from interface com.graphql_java_generator.plugin.conf.CommonConfiguration

getDefaultTargetSchemaFileName, getEnumPrefix, getEnumSuffix, getInputPrefix, getInputSuffix, getInterfacePrefix, getInterfaceSuffix, getJsonGraphqlSchemaFilename, getMaxTokens, getProjectDir, getSchemaFileFolder, getSchemaFilePattern, getTargetSchemaSubFolder, getTemplates, getTypePrefix, getTypeSuffix, getUnionPrefix, getUnionSuffix, isAddRelayConnections, isSkipGenerationIfSchemaHasNotChanged, logCommonConfiguration

Methods inherited from interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

getCustomScalars, getMode, getPackageName, getQueryMutationExecutionProtocol, getSchemaPersonalizationFile, getSourceEncoding, getSpringAutoConfigurationPackage, getSpringBeanSuffix, getTargetClassFolder, getTargetResourceFolder, getTargetSourceFolder, isCopyRuntimeSources, isGenerateUtilityClasses, isSeparateUtilityClasses, isUseJakartaEE9, logGenerateCodeCommonConfiguration

Field Details

DEFAULT_GENERATE_DEPRECATED_REQUEST_RESPONSE

static final String DEFAULT_GENERATE_DEPRECATED_REQUEST_RESPONSE

See Also:

• Constant Field Values

Method Details

isGenerateDeprecatedRequestResponse

boolean isGenerateDeprecatedRequestResponse()

(since 1.7.1 version) Default value is _true_ for 1.x version, and _false_ for version 2.0 and after.

If this parameter is set to true, the plugin generates a XxxxResponse class for each query/mutation/subscription, and (if separateUtilityClasses is true) Xxxx classes in the util subpackage. This allows to keep compatibility with code Developed with the 1.x versions of the plugin.

The recommended way to use the plugin is to directly use the Xxxx query/mutation/subscription executor classes, where Xxxx is the query/mutation/subscription name defined in the GraphQL schema. To do this, set this parameter to _false_, and use the plugin as described in the wiki client page.

isGenerateJacksonAnnotations

default boolean isGenerateJacksonAnnotations()

This method is used only in GeneratePojoConfiguration.

In client mode, the Jackson annotations are always generated

Specified by:

isGenerateJacksonAnnotations in interface CommonConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns true

See Also:

• GeneratePojoConfiguration.isGenerateJacksonAnnotations()

logConfiguration

default void logConfiguration()

Logs all the configuration parameters (only when in the debug level)

Specified by:

logConfiguration in interface CommonConfiguration

Specified by:

logConfiguration in interface GenerateCodeCommonConfiguration