Package net.fabricmc.loom.configuration.processors

Class ModJavadocProcessor

java.lang.Object

net.fabricmc.loom.configuration.processors.ModJavadocProcessor

All Implemented Interfaces:

MinecraftJarProcessor<ModJavadocProcessor.Spec>, org.gradle.api.Named

public abstract class ModJavadocProcessor
extends Object
implements MinecraftJarProcessor<ModJavadocProcessor.Spec>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ModJavadocProcessor.Descriptor	用于在执行期重建 ModJavadocProcessor 的描述符.
static final record	ModJavadocProcessor.ModJavadoc
static final record	ModJavadocProcessor.Spec

Nested classes/interfaces inherited from interface net.fabricmc.loom.api.processor.MinecraftJarProcessor

MinecraftJarProcessor.MappingsProcessor<S>, MinecraftJarProcessor.ProcessorDescriptor<T extends MinecraftJarProcessor<?>>

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

org.gradle.api.Named.Namer

Constructor Summary

Constructors

Constructor	Description
ModJavadocProcessor(String name)

Method Summary

Modifier and Type	Method	Description
@Nullable ModJavadocProcessor.Spec	buildSpec(SpecContext context)
ModJavadocProcessor.Descriptor	descriptor()	返回一个描述符，用于在执行期重建本 processor 的实例.
String	getName()
void	processJar(Path jar, ModJavadocProcessor.Spec spec, ProcessorContext context)
@Nullable MinecraftJarProcessor.MappingsProcessor<ModJavadocProcessor.Spec>	processMappings()

Methods inherited from class java.lang.Object

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

Constructor Details

ModJavadocProcessor

@Inject
public ModJavadocProcessor(String name)

Method Details

getName

public String getName()

Specified by:

getName in interface org.gradle.api.Named

descriptor

public ModJavadocProcessor.Descriptor descriptor()

Description copied from interface: MinecraftJarProcessor

返回一个描述符，用于在执行期重建本 processor 的实例.

配置期构造的 processor 实例常常持有无法放进任务状态的对象（例如 Project、 Gradle 服务对象、任意的第三方实现），直接作为任务输入会破坏配置缓存。因此把重建所需的最小输入 提取成描述符中的纯值，由执行期的任务调用 MinecraftJarProcessor.ProcessorDescriptor.createProcessor(org.gradle.api.model.ObjectFactory) 重建实例。

默认实现直接抛出异常，以保证对既有第三方实现的二进制与源码兼容：未实现本方法的 processor 依然可以正常参与配置期的处理，只是无法参与执行期重建。

Specified by:

descriptor in interface MinecraftJarProcessor<ModJavadocProcessor.Spec>

buildSpec

public @Nullable ModJavadocProcessor.Spec buildSpec(SpecContext context)

Specified by:

buildSpec in interface MinecraftJarProcessor<ModJavadocProcessor.Spec>

processJar

public void processJar(Path jar,
 ModJavadocProcessor.Spec spec,
 ProcessorContext context)

Specified by:

processJar in interface MinecraftJarProcessor<ModJavadocProcessor.Spec>

processMappings

public @Nullable MinecraftJarProcessor.MappingsProcessor<ModJavadocProcessor.Spec> processMappings()

Specified by:

processMappings in interface MinecraftJarProcessor<ModJavadocProcessor.Spec>