Package net.fabricmc.loom.task

Class RemapJarTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.AbstractCopyTask
org.gradle.api.tasks.bundling.AbstractArchiveTask
org.gradle.api.tasks.bundling.Zip
org.gradle.jvm.tasks.Jar
net.fabricmc.loom.task.AbstractRemapJarTask
net.fabricmc.loom.task.RemapJarTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public abstract class RemapJarTask extends AbstractRemapJarTask

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RemapJarTask.RemapAction
     
    static interface 
    RemapJarTask.RemapParams
     

    Nested classes/interfaces inherited from class net.fabricmc.loom.task.AbstractRemapJarTask

    AbstractRemapJarTask.AbstractRemapAction<T extends AbstractRemapJarTask.AbstractRemapParams>, AbstractRemapJarTask.AbstractRemapParams

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

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from class org.gradle.jvm.tasks.Jar

    DEFAULT_EXTENSION

    Fields inherited from class org.gradle.api.tasks.bundling.Zip

    ZIP_EXTENSION

    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
    RemapJarTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    copy()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getAddNestedDependencies()
     
    abstract org.gradle.api.provider.SetProperty<String>
    getAtAccessWideners()
    Gets the jar paths to the access wideners that will be converted to ATs for Forge runtime.
    protected org.gradle.api.provider.Provider<? extends ClientEntriesService.Options>
    getClientOnlyEntriesOptionsProvider(org.gradle.api.tasks.SourceSet clientSourceSet)
     
    abstract org.gradle.api.provider.Property<Boolean>
    getInjectAccessWidener()
    Sets the "accessWidener" property in the fabric.mod.json, if the project is using access wideners.
    abstract org.gradle.api.file.RegularFileProperty
    getInjectedAccessWidenerPath()
    The path of the access widener to inject if injectAccessWidener is enabled.
    abstract org.gradle.api.provider.ListProperty<MixinRefmapService.Options>
    getMixinRefmapServiceOptions()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getNestedJars()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getOptimizeFabricModJson()
    Whether to optimize the fabric.mod.json file, by default this is false.
    abstract org.gradle.api.provider.Property<Boolean>
    getReadMixinConfigsFromManifest()
    Configures whether to read mixin configs from jar manifest if a fabric.mod.json cannot be found.
    abstract org.gradle.api.provider.Property<TinyRemapperService.Options>
    getTinyRemapperServiceOptions()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getUseMixinAP()
     

    Methods inherited from class net.fabricmc.loom.task.AbstractRemapJarTask

    applyClientOnlyManifestAttributes, getAdditionalClientOnlyEntries, getClasspath, getClientEntriesServiceOptions, getClientOnlySourceSetName, getCustomMappings, getIncludesClientOnlyClasses, getInput, getInputFile, getJarType, getModPlatform, getSourceNamespace, getTargetNamespace, getWorkerExecutor, submitWork

    Methods inherited from class org.gradle.jvm.tasks.Jar

    getManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharset

    Methods inherited from class org.gradle.api.tasks.bundling.Zip

    createCopyAction, getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64

    Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTask

    createCopyActionExecuter, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveVersion, getDestinationDirectory, getFileSystemOperations, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrder, useFileSystemPermissions

    Methods inherited from class org.gradle.api.tasks.AbstractCopyTask

    createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getPropertyFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDuplicatesStrategy, setExcludes, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

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

    conventionMapping, conventionMapping, getConventionMapping

    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

    • RemapJarTask

      @Inject public RemapJarTask()

  • Method Details

    • getNestedJars

      @InputFiles @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.ConfigurableFileCollection getNestedJars()

    • getAddNestedDependencies

      @Input public abstract org.gradle.api.provider.Property<Boolean> getAddNestedDependencies()

    • getOptimizeFabricModJson

      @Input public abstract org.gradle.api.provider.Property<Boolean> getOptimizeFabricModJson()
      Whether to optimize the fabric.mod.json file, by default this is false.

      The schemaVersion entry will be placed first in the json file

    • getAtAccessWideners

      @Input public abstract org.gradle.api.provider.SetProperty<String> getAtAccessWideners()
      Gets the jar paths to the access wideners that will be converted to ATs for Forge runtime. If you specify multiple files, they will be merged into one.

      The specified files will be converted and removed from the final jar.

      Returns:
      the property containing access widener paths in the final jar

    • getReadMixinConfigsFromManifest

      @Input public abstract org.gradle.api.provider.Property<Boolean> getReadMixinConfigsFromManifest()
      Configures whether to read mixin configs from jar manifest if a fabric.mod.json cannot be found.

      This is enabled by default on Forge, but not on other platforms.

      Returns:
      the property

    • getInjectAccessWidener

      @Input public abstract org.gradle.api.provider.Property<Boolean> getInjectAccessWidener()
      Sets the "accessWidener" property in the fabric.mod.json, if the project is using access wideners.
      Returns:
      the property

    • getInjectedAccessWidenerPath

      @InputFile @Optional @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.RegularFileProperty getInjectedAccessWidenerPath()
      The path of the access widener to inject if injectAccessWidener is enabled.

    • getUseMixinAP

      @Input @Internal public abstract org.gradle.api.provider.Property<Boolean> getUseMixinAP()

    • getTinyRemapperServiceOptions

      public abstract org.gradle.api.provider.Property<TinyRemapperService.Options> getTinyRemapperServiceOptions()

    • getMixinRefmapServiceOptions

      public abstract org.gradle.api.provider.ListProperty<MixinRefmapService.Options> getMixinRefmapServiceOptions()

    • copy

      protected void copy()
      Overrides:
      copy in class org.gradle.api.tasks.AbstractCopyTask

    • getClientOnlyEntriesOptionsProvider

      protected org.gradle.api.provider.Provider<? extends ClientEntriesService.Options> getClientOnlyEntriesOptionsProvider(org.gradle.api.tasks.SourceSet clientSourceSet)
      Specified by:
      getClientOnlyEntriesOptionsProvider in class AbstractRemapJarTask