Class CheckModuleExports

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.kyori.indra.task.CheckModuleExports
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public abstract class CheckModuleExports extends org.gradle.api.DefaultTask
Validate that all packages within a module are appropriately exported.
Since:
2.1.0
  • 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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    exclude(String... prefixes)
    Add package prefix exclusions for module validation.
    abstract org.gradle.api.file.RegularFileProperty
    A file property referring to the module jar checked in this task.
    abstract org.gradle.api.provider.SetProperty<String>
    Get package prefixes that do not have to be exported.
    void
     

    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

    • CheckModuleExports

      public CheckModuleExports()
  • Method Details

    • getCheckedModule

      @InputFile public abstract org.gradle.api.file.RegularFileProperty getCheckedModule()
      A file property referring to the module jar checked in this task.
      Returns:
      the checked module
    • getExclusions

      @Input public abstract org.gradle.api.provider.SetProperty<String> getExclusions()
      Get package prefixes that do not have to be exported.
      Returns:
      the package exclusion property
    • exclude

      public void exclude(String... prefixes)
      Add package prefix exclusions for module validation.
      Parameters:
      prefixes - the prefixes to exclude
    • validateModule

      public void validateModule() throws IOException
      Throws:
      IOException