Transformer (AutoRenamingTool 2.0.16 API)

All Known Implementing Classes:

FFLineFixer, IdentifierFixer, ParameterAnnotationFixer, ParameterFinalFlagRemover, RecordFixer, RenamingTransformer, SignatureStripperTransformer, SourceFixer
```
public interface Transformer
```
A Transformer is the basic building block for transforming entries read from a JAR file. Transformers can be registered to a Renamer.Builder to run over all entries.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Transformer.ClassEntry` A `ClassEntry` represents a class file entry in a JAR file.
`static interface`	`Transformer.Context` Context providing renamer state when creating a transformer.
`static interface`	`Transformer.Entry` A `Entry` is a single entry representing an entry in a JAR file.
`static interface`	`Transformer.Factory` A factory to create transformers using `Renamer` instance-specific information.
`static interface`	`Transformer.JavadoctorEntry` A `JavadoctorEntry` represents a `javadoctor.json` entry in a JAR file.
`static interface`	`Transformer.ManifestEntry` A `ManifestEntry` represents a manifest entry in a JAR file.
`static interface`	`Transformer.ResourceEntry` A `ResourceEntry` represents a generic resource entry in a JAR file that is not a class file, manifest or `javadoctor.json` file.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static Transformer.Factory`	`fernFlowerLineFixerFactory(java.io.File sourceJar)` Create a transformer that applies line number corrections from Fernflower.
`default java.util.Collection<? extends Transformer.Entry>`	`getExtras()` Returns extra entries to add to the JAR file.
`static Transformer.Factory`	`identifierFixerFactory(IdentifierFixerConfig config)` Create a transformer that renames any local variables that are not valid java identifiers.
`static Transformer.Factory`	`parameterAnnotationFixerFactory()` Create a transformer that fixes misaligned parameter annotations caused by Proguard.
`static Transformer.Factory`	`parameterFinalFlagRemoverFactory()` Create a transformer that removes the final attribute from parameter metadata.
`default Transformer.ClassEntry`	`process(Transformer.ClassEntry entry)` Processes a class entry and returns the transformed entry.
`default Transformer.JavadoctorEntry`	`process(Transformer.JavadoctorEntry entry)` Processes a javadoctor entry and returns the transformed entry.
`default Transformer.ManifestEntry`	`process(Transformer.ManifestEntry entry)` Processes a manifest entry and returns the transformed entry.
`default Transformer.ResourceEntry`	`process(Transformer.ResourceEntry entry)` Processes a resource entry and returns the transformed entry.
`static Transformer.Factory`	`recordFixerFactory()` Create a transformer that restores record component data stripped by ProGuard.
`static Transformer.Factory`	`renamerFactory(net.neoforged.srgutils.IMappingFile map, boolean collectAbstractParams)` Create a transformer that applies mappings as a transformation.
`static Transformer.Factory`	`signatureStripperFactory(SignatureStripperConfig config)` Create a transformer that strips invalid code signing signatures from a manifest.
`static Transformer.Factory`	`sourceFixerFactory(SourceFixerConfig config)` Create a transformer that fixes the `SourceFile` attribute of classes.

- Method Detail
  - process
```
default Transformer.ClassEntry process(Transformer.ClassEntry entry)
```
    Processes a class entry and returns the transformed entry.
    
    Parameters:
    
    entry - the original entry
    
    Returns:
    
    the transformed entry
  - process
```
default Transformer.ManifestEntry process(Transformer.ManifestEntry entry)
```
    Processes a manifest entry and returns the transformed entry.
    
    Parameters:
    
    entry - the original entry
    
    Returns:
    
    the transformed entry
  - process
```
default Transformer.ResourceEntry process(Transformer.ResourceEntry entry)
```
    Processes a resource entry and returns the transformed entry.
    
    Parameters:
    
    entry - the original entry
    
    Returns:
    
    the transformed entry
  - process
```
default Transformer.JavadoctorEntry process(Transformer.JavadoctorEntry entry)
```
    Processes a javadoctor entry and returns the transformed entry.
    
    Parameters:
    
    entry - the original entry
    
    Returns:
    
    the transformed entry
  - getExtras
```
default java.util.Collection<? extends Transformer.Entry> getExtras()
```
    Returns extra entries to add to the JAR file.
  - renamerFactory
```
static Transformer.Factory renamerFactory(net.neoforged.srgutils.IMappingFile map,
                                          boolean collectAbstractParams)
```
    Create a transformer that applies mappings as a transformation.
    
    Parameters:
    
    map - the mapping information to remap with
    
    collectAbstractParams - whether to collect abstract parameter names for FernFlower
    
    Returns:
    
    a factory for a renaming transformer
  - identifierFixerFactory
```
static Transformer.Factory identifierFixerFactory(IdentifierFixerConfig config)
```
    Create a transformer that renames any local variables that are not valid java identifiers.
    
    Parameters:
    
    config - option for which local variables to rename
    
    Returns:
    
    an identifier-fixing transformer
  - parameterAnnotationFixerFactory
```
static Transformer.Factory parameterAnnotationFixerFactory()
```
    Create a transformer that fixes misaligned parameter annotations caused by Proguard.
    
    Returns:
    
    a factory for a parameter annotation-fixing transformer
  - parameterFinalFlagRemoverFactory
```
static Transformer.Factory parameterFinalFlagRemoverFactory()
```
    Create a transformer that removes the final attribute from parameter metadata.
  - fernFlowerLineFixerFactory
```
static Transformer.Factory fernFlowerLineFixerFactory(java.io.File sourceJar)
```
    Create a transformer that applies line number corrections from Fernflower.
    
    Parameters:
    
    sourceJar - the source jar
    
    Returns:
    
    a factory for a transformer that applies line number information
  - recordFixerFactory
```
static Transformer.Factory recordFixerFactory()
```
    Create a transformer that restores record component data stripped by ProGuard.
    
    Returns:
    
    a factory for a transformer that fixes record class metadata
  - sourceFixerFactory
```
static Transformer.Factory sourceFixerFactory(SourceFixerConfig config)
```
    Create a transformer that fixes the SourceFile attribute of classes.
    This attempts to infer a file name based on the supplied language information.
    
    Parameters:
    
    config - the method to use to generate a source file name.
    
    Returns:
    
    a transformer that fixes SourceFile information
  - signatureStripperFactory
```
static Transformer.Factory signatureStripperFactory(SignatureStripperConfig config)
```
    Create a transformer that strips invalid code signing signatures from a manifest.
    
    Parameters:
    
    config - the variants of signatures to strip
    
    Returns:
    
    a factory for a transformer that strips signatures

Interface Transformer

Nested Class Summary

Method Summary

Method Detail

process

process

process

process

getExtras

renamerFactory

identifierFixerFactory

parameterAnnotationFixerFactory

parameterFinalFlagRemoverFactory

fernFlowerLineFixerFactory

recordFixerFactory

sourceFixerFactory

signatureStripperFactory