Interface ArtifactAccessTransformer.Parameters

All Superinterfaces:
TransformParameters
Enclosing class:
ArtifactAccessTransformer
public static interface ArtifactAccessTransformer.Parameters extends TransformParameters
The parameters for the transform action.

  • Method Details

    • getClasspath

      @InputFiles Property<FileCollection> getClasspath()
      The dependency configuration to resolve where AccessTransformers will be found in.
      Returns:
      A property for the AccessTransformers dependency

    • getMainClass

      @Optional @Input Property<String> getMainClass()
      The main class for AccessTransformers.
      Returns:
      A property for the main class to use
      API Note:
      This is only required if you are providing a custom AccessTransformers which is not a single jar.

    • getJavaLauncher

      @Input Property<String> getJavaLauncher()

      The executable path of the Java launcher to use to run AccessTransformers.

      This can be acquired by mapping (a provider of) a JavaLauncher to JavaLauncher.getExecutablePath() -> RegularFile.getAsFile() -> File.getAbsolutePath().

      Returns:
      A property for the path of the Java launcher

    • getArgs

      @Input ListProperty<String> getArgs()

      The arguments to pass into AccessTransformers.

      These arguments accept tokens that will be replaced when the transform action is run.

      • inJar - The input jar
      • atFile - The AccessTransformers configuration file
      • outJar - The output jar
      • logFile - The log file
      Returns:
      A property for the arguments

    • getConfig

      @InputFile RegularFileProperty getConfig()

      The AccessTransformer configuration to use.

      This is usually named accesstransformer.cfg. In Forge, it is required in production that this file exists in the mod jar's META-INF directory.

      Returns:
      A property for the AccessTransformer configuration

    • getCachesDir

      @InputDirectory DirectoryProperty getCachesDir()

      The caches directory to use.

      This will include non-transform output files, such as in-house caching for the transformation process.

      Returns:
      A property for the caches directory