Class JavaToSchemaTask
-
- All Implemented Interfaces:
-
kotlin.Comparable,org.gradle.api.Named,org.gradle.api.Task,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.TaskInternal,org.gradle.api.plugins.ExtensionAware,org.gradle.util.Configurable
@CacheableTask() public abstract class JavaToSchemaTask extends DefaultTaskThis task generates a schema file from existing sources.
-
-
Field Summary
Fields Modifier and Type Field Description private FileoutputDirprivate FileinputDirprivate List<String>excludesprivate List<String>includesprivate Map<String, String>namespaceconfigsprivate Stringepisodeprivate StringantTaskClassNameprivate final ConfigurableFileCollectionjaxbClasspathfilesprivate final ConfigurableFileCollectionaddjaxbClasspathfilesprivate final ConfigurableFileCollectionclasspathfilesprivate final TaskOutputsInternaloutputsprivate final Spec<in TaskInternal>onlyIfprivate final Property<Duration>timeoutprivate final TaskRequiredServicesrequiredServicesprivate final TaskDependencyInternaltaskDependenciesprivate final Set<Object>dependsOnprivate final TaskDestroyablesdestroyablesprivate final Loggerloggerprivate final Stringpathprivate final Factory<File>temporaryDirFactoryprivate final Optional<String>reasonTaskIsIncompatibleWithConfigurationCacheprivate final TaskLocalStatelocalStateprivate final List<InputChangesAwareTaskAction>taskActionsprivate final TaskDependencyInternallifecycleDependenciesprivate BooleanisEnabledprivate BooleanimpliesSubProjectsprivate final TaskInputsInternalinputsprivate Booleanenabledprivate final TaskStateInternalstateprivate final TaskIdentity<?>taskIdentityprivate final TaskDependencyshouldRunAfterprivate final ExtensionContainerextensionsprivate final BooleanisCompatibleWithConfigurationCacheprivate final TaskDependencyfinalizedByprivate final AntBuilderantprivate final DynamicObjectasDynamicObjectprivate final List<ResourceLock>sharedResourcesprivate BooleandidWorkprivate final Optional<String>reasonNotToTrackStateprivate Stringgroupprivate final Set<String>reasonsNotToTrackStateprivate final BooleanisHasCustomActionsprivate List<Action<in Task>>actionsprivate final Stringnameprivate final FiletemporaryDirprivate final LoggingManagerloggingprivate final PathidentityPathprivate final TaskDependencymustRunAfterprivate final StandardOutputCapturestandardOutputCaptureprivate final Projectprojectprivate Stringdescription
-
Constructor Summary
Constructors Constructor Description JavaToSchemaTask(ObjectFactory objectFactory)
-
Method Summary
Modifier and Type Method Description final FilegetOutputDir()Output directory for Schema gen. final UnitsetOutputDir(File value)Output directory for Schema gen. final FilegetInputDir()Input directory for Schema gen. final UnitsetInputDir(File value)Input directory for Schema gen. final List<String>getExcludes()List of excludes patterns for input directory. final UnitsetExcludes(List<String> value)List of excludes patterns for input directory. final List<String>getIncludes()List of includes patterns for input directory. final UnitsetIncludes(List<String> value)List of includes patterns for input directory. final Map<String, String>getNamespaceconfigs()Provider for a map of name space configurations. final UnitsetNamespaceconfigs(Map<String, String> value)Provider for a map of name space configurations. final StringgetEpisode()Special parameter (episode) see schemagen documentation. final UnitsetEpisode(String <set-?>)Special parameter (episode) see schemagen documentation. final StringgetAntTaskClassName()This is the classname of javagen. final UnitsetAntTaskClassName(String <set-?>)This is the classname of javagen. final ConfigurableFileCollectiongetJaxbClasspathfiles()Classpath files for Java code generation (see Jaxb configuration (JAXB_CONFIGURATION_NAME)). final ConfigurableFileCollectiongetAddjaxbClasspathfiles()Additional classpath files for Java code generation (see Jaxb configuration (ADD_JAXB_CONFIGURATION_NAME)). final ConfigurableFileCollectiongetClasspathfiles()Classpath files for Java code generation. final UnitprovideOutputDir(Provider<Directory> outputDir)This function set the output directory provider. final UnitprovideInputDir(Provider<Directory> inputDir)This function set the input directory provider. final UnitprovideExcludes(Provider<List<String>> excludes)This function set the excludes provider. final UnitprovideIncludes(Provider<List<String>> includes)This function set the includes provider. final UnitprovideNamespaceconfigs(Provider<Map<String, String>> namespaceconfigs)This function set the namespaceconfigs provider. final UnitprovideEpisode(Provider<String> episode)This function set the input property episode. final UnitprovideAntTaskClassName(Provider<String> antTaskClassName)This function set the classname of javagen. final Unitgenerate()This generates a schema files from java source code. -
Methods inherited from class org.gradle.api.DefaultTask
getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup -
Methods inherited from class org.gradle.api.internal.AbstractTask
getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects -
Methods inherited from class org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService -
Methods inherited from class kotlin.Comparable
compareTo -
Methods inherited from class org.gradle.api.internal.TaskInternal
acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getOutputDir
@OutputDirectory() final File getOutputDir()
Output directory for Schema gen.
-
setOutputDir
final Unit setOutputDir(File value)
Output directory for Schema gen.
-
getInputDir
@InputDirectory()@PathSensitive(value = PathSensitivity.RELATIVE) final File getInputDir()
Input directory for Schema gen.
-
setInputDir
final Unit setInputDir(File value)
Input directory for Schema gen.
-
getExcludes
@Input() final List<String> getExcludes()
List of excludes patterns for input directory.
-
setExcludes
final Unit setExcludes(List<String> value)
List of excludes patterns for input directory.
-
getIncludes
@Input() final List<String> getIncludes()
List of includes patterns for input directory.
-
setIncludes
final Unit setIncludes(List<String> value)
List of includes patterns for input directory.
-
getNamespaceconfigs
@Input() final Map<String, String> getNamespaceconfigs()
Provider for a map of name space configurations.
-
setNamespaceconfigs
final Unit setNamespaceconfigs(Map<String, String> value)
Provider for a map of name space configurations.
-
getEpisode
@Optional()@Input() final String getEpisode()
Special parameter (episode) see schemagen documentation.
-
setEpisode
final Unit setEpisode(String <set-?>)
Special parameter (episode) see schemagen documentation.
-
getAntTaskClassName
@Input() final String getAntTaskClassName()
This is the classname of javagen.
-
setAntTaskClassName
final Unit setAntTaskClassName(String <set-?>)
This is the classname of javagen.
-
getJaxbClasspathfiles
@Classpath() final ConfigurableFileCollection getJaxbClasspathfiles()
Classpath files for Java code generation (see Jaxb configuration (JAXB_CONFIGURATION_NAME)).
The plugin wires this at configuration time. The task must not resolve the configuration itself, because that would happen during input snapshotting in the execution phase, where accessing {@code Task.project} is deprecated in Gradle 9 and fails in Gradle 10.
-
getAddjaxbClasspathfiles
@Classpath() final ConfigurableFileCollection getAddjaxbClasspathfiles()
Additional classpath files for Java code generation (see Jaxb configuration (ADD_JAXB_CONFIGURATION_NAME)).
The plugin wires this at configuration time, see {@link #jaxbClasspathfiles}.
-
getClasspathfiles
@CompileClasspath() final ConfigurableFileCollection getClasspathfiles()
Classpath files for Java code generation.
The plugin wires this at configuration time, see {@link #jaxbClasspathfiles}.
-
provideOutputDir
final Unit provideOutputDir(Provider<Directory> outputDir)
This function set the output directory provider.
-
provideInputDir
final Unit provideInputDir(Provider<Directory> inputDir)
This function set the input directory provider.
-
provideExcludes
final Unit provideExcludes(Provider<List<String>> excludes)
This function set the excludes provider.
-
provideIncludes
final Unit provideIncludes(Provider<List<String>> includes)
This function set the includes provider.
-
provideNamespaceconfigs
final Unit provideNamespaceconfigs(Provider<Map<String, String>> namespaceconfigs)
This function set the namespaceconfigs provider.
-
provideEpisode
final Unit provideEpisode(Provider<String> episode)
This function set the input property episode.
-
provideAntTaskClassName
final Unit provideAntTaskClassName(Provider<String> antTaskClassName)
This function set the classname of javagen.
-
-
-
-