Package net.neoforged.fml.loading.moddiscovery.locators

Class NeoForgeDevDistCleaner

java.lang.Object

net.neoforged.fml.loading.moddiscovery.locators.NeoForgeDevDistCleaner

All Implemented Interfaces:

ClassProcessor

@Internal
public class NeoForgeDevDistCleaner
extends Object
implements ClassProcessor

Masks classes from the Minecraft jar that are for the wrong distribution in a development environment, throwing an informative exception.

Nested Class Summary

Nested classes/interfaces inherited from interface net.neoforged.neoforgespi.transformation.ClassProcessor

ClassProcessor.AfterProcessingContext, ClassProcessor.ComputeFlags, ClassProcessor.LinkContext, ClassProcessor.OrderingHint, ClassProcessor.SelectionContext, ClassProcessor.TransformationContext

Field Summary

Fields

Modifier and Type	Field	Description
private final net.neoforged.api.distmarker.Dist	dist
private static final org.slf4j.Marker	DISTXFORM
private static final org.slf4j.Logger	LOGGER
private final Set<String>	maskedClasses
private static final Attributes.Name	NAME_DIST
private static final Attributes.Name	NAME_DISTS

Fields inherited from interface net.neoforged.neoforgespi.transformation.ClassProcessor

GENERATED_PACKAGE_MODULE

Constructor Summary

Constructors

Constructor	Description
NeoForgeDevDistCleaner(JarContents minecraftModFile, net.neoforged.api.distmarker.Dist requestedDist)

Method Summary

Modifier and Type	Method	Description
static Stream<String>	getMaskedFiles(JarContents minecraftJar, net.neoforged.api.distmarker.Dist currentDist)	Loads file masking information from the jar's manifest, masking resource files that should not be present and telling NeoForgeDevDistCleaner to clean class files that should be masked.
boolean	handlesClass(ClassProcessor.SelectionContext context)	Returns whether the processor wants to recieve the class.
ProcessorName	name()	Returns a unique identifier for this processor.
ClassProcessor.ComputeFlags	processClass(ClassProcessor.TransformationContext context)	Each class that the processor has opted to recieve is passed to this method for processing.
Set<ProcessorName>	runsAfter()	Returns processors that this processor must run after.
Set<ProcessorName>	runsBefore()	Returns processors that this processor must run before.
static boolean	supportsDistCleaning(JarContents minecraftModFile)
private static <T, X extends Throwable> void	throwUnchecked(T throwable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.neoforgespi.transformation.ClassProcessor

afterProcessing, generatesPackages, link, orderingHint

Field Details

NAME_DISTS

private static final Attributes.Name NAME_DISTS

NAME_DIST

private static final Attributes.Name NAME_DIST

LOGGER

private static final org.slf4j.Logger LOGGER

DISTXFORM

private static final org.slf4j.Marker DISTXFORM

dist

private final net.neoforged.api.distmarker.Dist dist

maskedClasses

private final Set<String> maskedClasses

Constructor Details

NeoForgeDevDistCleaner

public NeoForgeDevDistCleaner(JarContents minecraftModFile,
 net.neoforged.api.distmarker.Dist requestedDist)

Method Details

supportsDistCleaning

public static boolean supportsDistCleaning(JarContents minecraftModFile)

name

public ProcessorName name()

Description copied from interface: ClassProcessor

Returns a unique identifier for this processor.

Specified by:

name in interface ClassProcessor

Returns:

a unique identifier for this processor

runsBefore

public Set<ProcessorName> runsBefore()

Description copied from interface: ClassProcessor

Returns processors that this processor must run before.

Specified by:

runsBefore in interface ClassProcessor

Returns:

processors that this processor must run before

runsAfter

public Set<ProcessorName> runsAfter()

Description copied from interface: ClassProcessor

Returns processors that this processor must run after. This should include ClassProcessorIds.COMPUTING_FRAMES if the processor returns a result requiring frame re-computation.

Specified by:

runsAfter in interface ClassProcessor

Returns:

processors that this processor must run after

processClass

public ClassProcessor.ComputeFlags processClass(ClassProcessor.TransformationContext context)

Description copied from interface: ClassProcessor

Each class that the processor has opted to recieve is passed to this method for processing.

Specified by:

processClass in interface ClassProcessor

Parameters:

context - the context of the class to process

Returns:

the ClassProcessor.ComputeFlags indicating how the class should be rewritten.

handlesClass

public boolean handlesClass(ClassProcessor.SelectionContext context)

Description copied from interface: ClassProcessor

Returns whether the processor wants to recieve the class.

Specified by:

handlesClass in interface ClassProcessor

Parameters:

context - the context of the class to consider

Returns:

whether the processor wants to recieve the class

throwUnchecked

private static <T,
X extends Throwable> void throwUnchecked(T throwable)
                                                     throws X

Throws:

X

getMaskedFiles

public static Stream<String> getMaskedFiles(JarContents minecraftJar,
 net.neoforged.api.distmarker.Dist currentDist)

Loads file masking information from the jar's manifest, masking resource files that should not be present and telling NeoForgeDevDistCleaner to clean class files that should be masked.