Package com.blackbuild.annodocimal.plugin

Class SourceProjectionTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.blackbuild.annodocimal.plugin.SourceProjectionTask
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 @NullMarked public abstract class SourceProjectionTask extends org.gradle.api.DefaultTask
Projects selected top-level class files into one exclusively managed source directory.

Include and exclude patterns use slash-normalized paths relative to each input directory. Patterns include the .class suffix; exclusions take precedence. The default selects every top-level class file.

  • Nested Class Summary

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

    org.gradle.api.Task.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
    SourceProjectionTask(org.gradle.api.model.ObjectFactory objects)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getClassesDirectories()
    Class-output directories containing candidate top-level class files.
    abstract org.gradle.api.provider.SetProperty<String>
    getExcludes()
    Ant-style exclude patterns over slash-normalized relative class-file paths.
    abstract org.gradle.api.provider.SetProperty<String>
    getIncludes()
    Ant-style include patterns over slash-normalized relative class-file paths.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
    The directory exclusively managed by this task.
    abstract org.gradle.api.provider.Property<com.blackbuild.annodocimal.generator.ProjectionPolicy>
    getProjectionPolicy()
    Inclusion policy passed to the documentation-oriented source projector.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getReferencedClassesClasspath()
    Directories and JARs used to resolve referenced declarations while projecting selected classes.
    protected final void
    projectSources()
     

    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, getConvention, 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 org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • SourceProjectionTask

      @Inject public SourceProjectionTask(org.gradle.api.model.ObjectFactory objects)

  • Method Details

    • getClassesDirectories

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getClassesDirectories()
      Class-output directories containing candidate top-level class files.
      Returns:
      documentation-sensitive class inputs

    • getReferencedClassesClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getReferencedClassesClasspath()
      Directories and JARs used to resolve referenced declarations while projecting selected classes.

      Configure this with the selected classes' compile classpath, or a narrower runtime classpath that contains every referenced declaration whose nested Java name must be classified. It is not scanned for projection roots.

      Returns:
      referenced-declaration classpath

    • getIncludes

      @Input public abstract org.gradle.api.provider.SetProperty<String> getIncludes()
      Ant-style include patterns over slash-normalized relative class-file paths.
      Returns:
      selected candidate patterns

    • getExcludes

      @Input public abstract org.gradle.api.provider.SetProperty<String> getExcludes()
      Ant-style exclude patterns over slash-normalized relative class-file paths.
      Returns:
      excluded candidate patterns

    • getProjectionPolicy

      public abstract org.gradle.api.provider.Property<com.blackbuild.annodocimal.generator.ProjectionPolicy> getProjectionPolicy()
      Inclusion policy passed to the documentation-oriented source projector.
      Returns:
      projection policy

    • getOutputDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()
      The directory exclusively managed by this task.
      Returns:
      managed source output directory

    • projectSources

      protected final void projectSources()