buildcraft.api.core

Class CapabilitiesHelper

java.lang.Object

buildcraft.api.core.CapabilitiesHelper

public class CapabilitiesHelper
extends java.lang.Object

Forge has a wonderful system for capabilities, which provides a better way of managing mod compat even if the target mod isn't loaded. Said system uses ASM data to inject capabilities into every mod, which makes it a matter of checking a (generic) field at runtime.

Unfortunately this doesn't even slightly work when using a test framework like JUnit, as CapabilityManager#register(Class, IStorage, Callable) doesn't return the registered Capability instances, and we don't load classes with forge's class loaders in JUnit. This class provides two useful methods to compensate: registerCapability(Class) and registerCapability(CheckedStorage, Callable), both of which returns the registered capability.

This is NOT designed for mods wishing to add compatibility for buildcraft capability instances: those should still go via the forge-recommended CapabilityInject route, or refer to the various fields in buildcraft api classes containing the capability instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilitiesHelper.CheckedStorage<T> A type of Capability.IStorage that contains the class that it would store.
static class	CapabilitiesHelper.ThrowingStorage<T> A type of CapabilitiesHelper.CheckedStorage that throws an UnsupportedOperationException from both the read and write methods.
static class	CapabilitiesHelper.VoidStorage<T>

Constructor Summary

Constructors

Constructor and Description
CapabilitiesHelper()

Method Summary

Modifier and Type	Method and Description
static <T> net.minecraftforge.common.capabilities.Capability<T>	ensureRegistration(net.minecraftforge.common.capabilities.Capability<T> cap, java.lang.Class<T> clazz) Deprecated.
static <T> net.minecraftforge.common.capabilities.Capability<T>	registerCapability(CapabilitiesHelper.CheckedStorage<T> storage, java.util.concurrent.Callable<T> factory) Registers a given type with the CapabilityManager, but also returns the capability instance.
static <T> net.minecraftforge.common.capabilities.Capability<T>	registerCapability(java.lang.Class<T> clazz) Registers a given type with registerCapability(CheckedStorage, Callable), but with a CapabilitiesHelper.ThrowingStorage and a factory that throws an UnsupportedOperationException instead of creating a new capability instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilitiesHelper

public CapabilitiesHelper()

Method Detail

registerCapability

@Nonnull
public static <T> net.minecraftforge.common.capabilities.Capability<T> registerCapability(java.lang.Class<T> clazz)

Registers a given type with registerCapability(CheckedStorage, Callable), but with a CapabilitiesHelper.ThrowingStorage and a factory that throws an UnsupportedOperationException instead of creating a new capability instance.

Parameters:

clazz - The type that all instances must derive from.

Returns:

The registered Capability

registerCapability

@Nonnull
public static <T> net.minecraftforge.common.capabilities.Capability<T> registerCapability(CapabilitiesHelper.CheckedStorage<T> storage,
                                                                                                   java.util.concurrent.Callable<T> factory)

Registers a given type with the CapabilityManager, but also returns the capability instance.

Parameters:

storage - The storage for the capability. This must extend CapabilitiesHelper.CheckedStorage in order to allow the internal mechanisms to ensure that nothing went wrong during our meddling into forge.

factory - The factory for the capability.

Returns:

The registered Capability

ensureRegistration

@Nonnull
 @Deprecated
public static <T> net.minecraftforge.common.capabilities.Capability<T> ensureRegistration(net.minecraftforge.common.capabilities.Capability<T> cap,
                                                                                                                java.lang.Class<T> clazz)

Deprecated.

Prefer registerCapability(Class) or other methods over this one: this will be removed at some point in the future. Most likely before beta.