net.neoforged.art.api

Interface Renamer

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface Renamer
extends java.io.Closeable

A Renamer is used to run generic transformers on a JAR file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Renamer.Builder A Renamer.Builder is used to configure and construct a Renamer.

Method Summary

Modifier and Type	Method and Description
static Renamer.Builder	builder() Creates a default instance of a Renamer.Builder.
void	run(java.io.File input, java.io.File output) Runs the renamer and all registered transformers on the input JAR file, and then outputs it to the output JAR file.
java.util.List<Transformer.Entry>	run(java.util.List<Transformer.Entry> entries) Runs the renamer and all registered transformers on the given input entries.
java.util.concurrent.CompletableFuture<java.util.List<Transformer.Entry>>	run(java.util.List<Transformer.Entry> entries, java.util.concurrent.ExecutorService executorService) Same as run(List), but ignores the configured RenamerBuilder.threads(int) and instead uses the given executorService for scheduling asynchronous tasks.

Methods inherited from interface java.io.Closeable

close

Method Detail

run

void run(java.io.File input,
         java.io.File output)

Runs the renamer and all registered transformers on the input JAR file, and then outputs it to the output JAR file. This method is guaranteed to be repeatable with multiple inputs and outputs.

Parameters:

input - the input JAR file to process

output - the output JAR file location

run

java.util.List<Transformer.Entry> run(java.util.List<Transformer.Entry> entries)

Runs the renamer and all registered transformers on the given input entries.

This method is guaranteed to be repeatable with multiple inputs and outputs.

Returns:

The entries of the renamed Jar file. Entries will be returned in the same order for the same input entries, but the order is otherwise undefined. The returned list may contain more or fewer entries than the input.

run

java.util.concurrent.CompletableFuture<java.util.List<Transformer.Entry>> run(java.util.List<Transformer.Entry> entries,
                                                                              java.util.concurrent.ExecutorService executorService)

Same as run(List), but ignores the configured RenamerBuilder.threads(int) and instead uses the given executorService for scheduling asynchronous tasks.

builder

static Renamer.Builder builder()

Creates a default instance of a Renamer.Builder.

Logs will be logged to System.out by default. Debug logs will be swallowed by default. Library files can be both ZIP files and directories. The default number of threads is determined from Runtime.availableProcessors().