Package com.graphql_java_generator.gradleplugin

Class GenerateGraphQLSchemaTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.graphql_java_generator.gradleplugin.CommonTask

com.graphql_java_generator.gradleplugin.GenerateGraphQLSchemaTask

All Implemented Interfaces:

com.graphql_java_generator.plugin.conf.CommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateGraphQLSchemaConfiguration, Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class GenerateGraphQLSchemaTask
extends CommonTask
implements com.graphql_java_generator.plugin.conf.GenerateGraphQLSchemaConfiguration

The generateGraphQLSchema goal generates GraphQL schema, based on the source GraphQL schemas, and possibly containing additional stuff, like the Relay connection objects.

It can be used to:

• Generate several GraphQL schema files into one file, for instance with additional schema files that would use the extend GraphQL keyword
• Reformat the schema file
• Generate the GraphQL schema with the Relay Connection stuff (Node interface, XxxEdge and XxxConnection types), thanks to the addRelayConnections plugin parameter.

This goal is, by default, attached to the Initialize maven phase, to be sure that the GraphQL schema are generated before the code generation would need it, if relevant.

Note: The attribute have no default values: their default values is read from the GenerateCodeCommonExtension, whose attributes can be either the default value, or a value set in the build script.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

org.gradle.api.Named.Namer

Field Summary

Fields inherited from class com.graphql_java_generator.gradleplugin.CommonTask

extension, skipGenerationIfSchemaHasNotChanged

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, DEFAULT_TARGET_SCHEMA_SUBFOLDER

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

DEFAULT_RESOURCE_ENCODING, DEFAULT_TARGET_FOLDER, DEFAULT_TARGET_SCHEMA_FILE_NAME

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
GenerateGraphQLSchemaTask(GenerateGraphQLSchemaExtension extension, org.gradle.api.file.ProjectLayout projectLayout)
GenerateGraphQLSchemaTask(org.gradle.api.file.ProjectLayout projectLayout)

Method Summary

Modifier and Type	Method	Description
void	execute()
protected GenerateGraphQLSchemaExtension	getExtension()
String	getResourceEncoding()
File	getTargetFolder()
String	getTargetSchemaFileName()
boolean	isGenerateJacksonAnnotations()
String	setResourceEncoding(String resourceEncoding)
void	setTargetFolder(String targetFolder)
void	setTargetSchemaFileName(String targetSchemaFileName)

Methods inherited from class com.graphql_java_generator.gradleplugin.CommonTask

getDefaultTargetSchemaFileName, getEnumPrefix, getEnumSuffix, getFileValue, getInputPrefix, getInputSuffix, getInterfacePrefix, getInterfaceSuffix, getJsonGraphqlSchemaFilename, getMaxTokens, getProjectBuildDir, getProjectDir, getProjectMainSourceFolder, getSchemaFileFolder, getSchemaFilePattern, getTargetSchemaSubFolder, getTemplates, getTypePrefix, getTypeSuffix, getUnionPrefix, getUnionSuffix, getValue, isAddRelayConnections, isInitialized, isSkipGenerationIfSchemaHasNotChanged, logConfiguration, setAddRelayConnections, setEnumPrefix, setEnumSuffix, setExtension, setInitialized, setInputPrefix, setInputSuffix, setInterfacePrefix, setInterfaceSuffix, setJsonGraphqlSchemaFilename, setParserOptions, setSchemaFileFolder, setSchemaFilePattern, setSkipGenerationIfSchemaHasNotChanged, setTargetSchemaSubFolder, setTemplates, setTypePrefix, setTypeSuffix, setUnionPrefix, setUnionSuffix

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

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

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

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

logConfiguration

Methods inherited from interface org.gradle.api.Task

doNotTrackState, notCompatibleWithConfigurationCache

Constructor Details

GenerateGraphQLSchemaTask

@Inject
public GenerateGraphQLSchemaTask(org.gradle.api.file.ProjectLayout projectLayout)

GenerateGraphQLSchemaTask

public GenerateGraphQLSchemaTask(GenerateGraphQLSchemaExtension extension,
 org.gradle.api.file.ProjectLayout projectLayout)

Method Details

execute

public void execute()
             throws IOException

Throws:

IOException

getResourceEncoding

@Input
public String getResourceEncoding()

Specified by:

getResourceEncoding in interface com.graphql_java_generator.plugin.conf.GenerateGraphQLSchemaConfiguration

setResourceEncoding

public String setResourceEncoding(String resourceEncoding)

getTargetFolder

@InputDirectory
public File getTargetFolder()

Specified by:

getTargetFolder in interface com.graphql_java_generator.plugin.conf.GenerateGraphQLSchemaConfiguration

setTargetFolder

public void setTargetFolder(String targetFolder)

Parameters:

targetFolder - A folder, relative to the project dir (not the the build dir)

getTargetSchemaFileName

@Input
public String getTargetSchemaFileName()

Specified by:

getTargetSchemaFileName in interface com.graphql_java_generator.plugin.conf.GenerateGraphQLSchemaConfiguration

setTargetSchemaFileName

public void setTargetSchemaFileName(String targetSchemaFileName)

getExtension

protected GenerateGraphQLSchemaExtension getExtension()

Overrides:

getExtension in class CommonTask

isGenerateJacksonAnnotations

@Internal
public boolean isGenerateJacksonAnnotations()

Specified by:

isGenerateJacksonAnnotations in interface com.graphql_java_generator.plugin.conf.CommonConfiguration

Overrides:

isGenerateJacksonAnnotations in class CommonTask