net.minecraftforge.common.capabilities

Enum CapabilityManager

java.lang.Object

java.lang.Enum<CapabilityManager>

net.minecraftforge.common.capabilities.CapabilityManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CapabilityManager>

public enum CapabilityManager
extends java.lang.Enum<CapabilityManager>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	injectCapabilities(ASMDataTable data)
<T> void	register(java.lang.Class<T> type, Capability.IStorage<T> storage, java.util.concurrent.Callable<? extends T> factory) Registers a capability to be consumed by others.
<T> void	register(java.lang.Class<T> type, Capability.IStorage<T> storage, java.lang.Class<? extends T> implementation) Registers a capability to be consumed by others.
static CapabilityManager	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapabilityManager[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final CapabilityManager INSTANCE

Method Detail

values

public static CapabilityManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CapabilityManager c : CapabilityManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CapabilityManager valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

register

public <T> void register(java.lang.Class<T> type,
                         Capability.IStorage<T> storage,
                         java.lang.Class<? extends T> implementation)

Registers a capability to be consumed by others. APIs who define the capability should call this. To retrieve the Capability instance, use the @CapabilityInject annotation.

Parameters:

type - The Interface to be registered

storage - A default implementation of the storage handler.

implementation - A default implementation of the interface.

register

public <T> void register(java.lang.Class<T> type,
                         Capability.IStorage<T> storage,
                         java.util.concurrent.Callable<? extends T> factory)

Registers a capability to be consumed by others. APIs who define the capability should call this. To retrieve the Capability instance, use the @CapabilityInject annotation.

Parameters:

type - The Interface to be registered

storage - A default implementation of the storage handler.

factory - A Factory that will produce new instances of the default implementation.

injectCapabilities

public void injectCapabilities(ASMDataTable data)