Package com.graphql_java_generator.plugin.conf

Interface GraphQLConfiguration

All Superinterfaces:

CommonConfiguration, GenerateClientCodeConfiguration, GenerateCodeCommonConfiguration, GenerateServerCodeConfiguration

All Known Subinterfaces:

GeneratePojoConfiguration

public interface GraphQLConfiguration
extends GenerateClientCodeConfiguration, GenerateServerCodeConfiguration

This interface contains all the configuration parameters for the graphql goal (Maven) or task (Gradle) of the plugin, as an interface.
All these methods are directly the property names, to map against a Spring Configuration that defines the Beans. These beans can then be reused in Spring Component, thank to Spring IoC and its dependency injection capability.

Author:

etienne-sf

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODE

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

DEFAULT_ADD_RELAY_CONNECTIONS, 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.GenerateClientCodeConfiguration

DEFAULT_GENERATE_DEPRECATED_REQUEST_RESPONSE

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

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

DEFAULT_GENERATE_BATCH_LOADER_ENVIRONMENT, DEFAULT_GENERATE_DATA_FETCHER_FOR_EVERY_FIELD_WITH_ARGUMENT, DEFAULT_GENERATE_DATA_LOADER_FOR_LISTS, DEFAULT_GENERATE_JPA_ANNOTATION, DEFAULT_JAVA_TYPE_FOR_ID_TYPE, DEFAULT_SCAN_BASE_PACKAGES

Method Summary

Modifier and Type	Method	Description
default boolean	isGenerateJacksonAnnotations()	This method is used only in GeneratePojoConfiguration.
default void	logConfiguration()	Logs all the configuration parameters for the graphql maven goal or graphqlGenerateCode gradle task (only when in the debug level)

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

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

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

isGenerateDeprecatedRequestResponse

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

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

getJavaTypeForIDType, getPackaging, getQuotedScanBasePackages, getScanBasePackages, isGenerateBatchLoaderEnvironment, isGenerateDataFetcherForEveryFieldsWithArguments, isGenerateDataLoaderForLists, isGenerateJPAAnnotation, logGenerateServerCodeConfiguration

Field Details

DEFAULT_MODE

static final String DEFAULT_MODE

See Also:

• Constant Field Values

Method Details

isGenerateJacksonAnnotations

default boolean isGenerateJacksonAnnotations()

This method is used only in GeneratePojoConfiguration.

In client mode, the Jackson annotations are always generated

In client mode, the Jackson annotations are always generated. In server mode, these annotations are never generated.

Specified by:

isGenerateJacksonAnnotations in interface CommonConfiguration

Specified by:

isGenerateJacksonAnnotations in interface GenerateClientCodeConfiguration

Specified by:

isGenerateJacksonAnnotations in interface GenerateServerCodeConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns true

See Also:

• GeneratePojoConfiguration.isGenerateJacksonAnnotations()

logConfiguration

default void logConfiguration()

Logs all the configuration parameters for the graphql maven goal or graphqlGenerateCode gradle task (only when in the debug level)

Specified by:

logConfiguration in interface CommonConfiguration

Specified by:

logConfiguration in interface GenerateClientCodeConfiguration

Specified by:

logConfiguration in interface GenerateCodeCommonConfiguration

Specified by:

logConfiguration in interface GenerateServerCodeConfiguration