Package io.github.besi97.graphql.codegen.gradle

Class GraphQLCodegenValidateGradleTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.besi97.graphql.codegen.gradle.GraphQLCodegenValidateGradleTask
All Implemented Interfaces:
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>
@CacheableTask public class GraphQLCodegenValidateGradleTask extends org.gradle.api.DefaultTask
Gradle task for GraphQL code generation

  • Nested Class Summary

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

    org.gradle.api.Named.Namer

  • Field Summary

    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
    GraphQLCodegenValidateGradleTask(org.gradle.api.file.ProjectLayout projectLayout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getGraphqlSchemaPaths()
     
    org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile>
    getValidationResultFile()
    Marker file that records a successful validation run.
    void
    setGraphqlSchemaPaths(List<String> graphqlSchemaPaths)
     
    void
    validate()
     

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • GraphQLCodegenValidateGradleTask

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

  • Method Details

    • validate

      public void validate() throws IOException
      Throws:
      IOException

    • getGraphqlSchemaPaths

      @InputFiles @PathSensitive(RELATIVE) public List<String> getGraphqlSchemaPaths()

    • setGraphqlSchemaPaths

      public void setGraphqlSchemaPaths(List<String> graphqlSchemaPaths)

    • getValidationResultFile

      @OutputFile public org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> getValidationResultFile()
      Marker file that records a successful validation run.

      A cacheable task must declare at least one output, otherwise Gradle silently disables caching for it. This file contains no meaningful data; it only makes the validation result incremental and cacheable.

      Returns:
      the validation result marker file property