Class RfgCacheService

java.lang.Object

com.gtnewhorizons.retrofuturagradle.mcp.RfgCacheService

All Implemented Interfaces:

Serializable, BuildService<RfgCacheService.Parameters>

public abstract class RfgCacheService
extends Object
implements BuildService<RfgCacheService.Parameters>, Serializable

A shared build service that can fetch and provide cached forge, mapping, etc. data for various MC versions.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RfgCacheService.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name you can use in ServiceReference to obtain an instance of this service.

Constructor Summary

Constructors

Constructor	Description
RfgCacheService()

Method Summary

Modifier and Type	Method	Description
static RfgCacheService	access(Gradle gradle)
Path	accessForgeUserdev(String forgeVersion)
Path	accessMcpMappings(String mcVersion, String channel, String mcpVersion)
Path	getFgCachePath()
Path	getRfgCachePath()
static Provider<RfgCacheService>	lazyAccess(Gradle gradle)
FileLock	lockCache(boolean shared)	Acquires a lock on the RFG cache directory.
static void	register(Gradle gradle)

Methods inherited from class Object

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

Methods inherited from interface BuildService

getParameters

Field Details

NAME

public static final String NAME

The name you can use in ServiceReference to obtain an instance of this service.

See Also:

• Constant Field Values

Constructor Details

RfgCacheService

@Inject
public RfgCacheService()

Method Details

lockCache

public FileLock lockCache(boolean shared)

Acquires a lock on the RFG cache directory.

Parameters:

shared - Whether the lock can be shared with other shared locks (for reading only), if false it must be exclusive (for writing).

Returns:

The lock acquired

register

public static void register(Gradle gradle)

access

public static RfgCacheService access(Gradle gradle)

lazyAccess

public static Provider<RfgCacheService> lazyAccess(Gradle gradle)

getRfgCachePath

public Path getRfgCachePath()

getFgCachePath

public Path getFgCachePath()

accessForgeUserdev

public Path accessForgeUserdev(String forgeVersion)

Parameters:

forgeVersion - The version of forge to get userdev for.

Returns:

The root of the extracted userdev archive.

accessMcpMappings

public Path accessMcpMappings(String mcVersion,
 String channel,
 String mcpVersion)

Parameters:

mcVersion - the MC version, e.g. 1.7.10 or 1.12.2

channel - stable or nightly

mcpVersion - the mapping version, e.g. 42

Returns:

The root of the extracted MCP archive.