Package com.graphql_java_generator.plugin.conf

Interface GeneratePojoConfiguration

All Superinterfaces:

CommonConfiguration, GenerateClientCodeConfiguration, GenerateCodeCommonConfiguration, GenerateServerCodeConfiguration, GraphQLConfiguration

public interface GeneratePojoConfiguration
extends GraphQLConfiguration

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

Author:

etienne-sf

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GENERATE_JACKSON_ANNOTATIONS

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.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_BATCH_MAPPING_DATA_FETCHER_RETURN_TYPE, DEFAULT_BATCH_MAPPING_DATA_FETCHER_RETURN_TYPE_STR, DEFAULT_GENERATE_BATCH_LOADER_ENVIRONMENT, DEFAULT_GENERATE_BATCH_MAPPING_DATA_FETCHERS, DEFAULT_GENERATE_DATA_FETCHER_FOR_EVERY_FIELD_WITH_ARGUMENT, DEFAULT_GENERATE_DATA_LOADER_FOR_LISTS, DEFAULT_GENERATE_JPA_ANNOTATION, DEFAULT_IGNORED_SPRING_MAPPINGS, DEFAULT_JAVA_TYPE_FOR_ID_TYPE, DEFAULT_SCAN_BASE_PACKAGES

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

DEFAULT_MODE

Method Summary

Modifier and Type	Method	Description
default PluginMode	getMode()	The mode is of no interest, here.
boolean	isGenerateJacksonAnnotations()	The Jackson annotations are necessary to properly deserialize the json, that is incoming from the GraphQL Server.
default boolean	isGenerateUtilityClasses()	The utility classes are not generated for this goal/task
default boolean	isSeparateUtilityClasses()	There is no utility classes for this goal.

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

isGenerateDeprecatedRequestResponse

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

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

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

getBatchMappingDataFetcherReturnType, getIgnoredSpringMappings, getJavaTypeForIDType, getPackaging, getQuotedScanBasePackages, getScanBasePackages, isGenerateBatchLoaderEnvironment, isGenerateBatchMappingDataFetchers, isGenerateDataFetcherForEveryFieldsWithArguments, isGenerateDataLoaderForLists, isGenerateJPAAnnotation, logGenerateServerCodeConfiguration

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

logConfiguration

Field Details

DEFAULT_GENERATE_JACKSON_ANNOTATIONS

static final String DEFAULT_GENERATE_JACKSON_ANNOTATIONS

See Also:

• Constant Field Values

Method Details

getMode

default PluginMode getMode()

The mode is of no interest, here.

Specified by:

getMode in interface GenerateCodeCommonConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns PluginMode.client

isGenerateJacksonAnnotations

boolean isGenerateJacksonAnnotations()

The Jackson annotations are necessary to properly deserialize the json, that is incoming from the GraphQL Server. Setting this property to false allows to not generate them.

If this property is set to true, the Jackson annotations are added in the generated GraphQL objects. The Jackson dependencies must then be added to the target project, so that the project compiles.

The default value is:

• true when in client mode.
• false when in server mode.

Specified by:

isGenerateJacksonAnnotations in interface CommonConfiguration

Specified by:

isGenerateJacksonAnnotations in interface GenerateClientCodeConfiguration

Specified by:

isGenerateJacksonAnnotations in interface GenerateServerCodeConfiguration

Specified by:

isGenerateJacksonAnnotations in interface GraphQLConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns true

See Also:

• isGenerateJacksonAnnotations()

isGenerateUtilityClasses

default boolean isGenerateUtilityClasses()

The utility classes are not generated for this goal/task

Specified by:

isGenerateUtilityClasses in interface GenerateCodeCommonConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns false

isSeparateUtilityClasses

default boolean isSeparateUtilityClasses()

There is no utility classes for this goal.

Specified by:

isSeparateUtilityClasses in interface GenerateCodeCommonConfiguration

Returns:

The GeneratePojoConfiguration implementation of this method always returns false