org.spongepowered.asm.service

Interface IMixinService

public interface IMixinService

Mixin Service interface. Mixin services connect the mixin subsytem to the underlying environment. It is something of a god interface at present because it contains all of the current functionality accessors for calling into launchwrapper. In the future once support for modlauncher is added, it is anticipated that the interface can be split down into sub-services which handle different aspects of interacting with the environment.

Method Summary

Modifier and Type	Method and Description
void	beginPhase() Called whenever a new phase is started
void	checkEnv(java.lang.Object bootSource) Check whether the supplied object is a valid boot source for mixin environment
IClassBytecodeProvider	getBytecodeProvider() Return the class bytecode provider for this service
IClassProvider	getClassProvider() Return the class provider for this service
java.lang.String	getClassRestrictions(java.lang.String className) Check whether the specified class name is subject to any restrictions in the context of this service
MixinEnvironment.Phase	getInitialPhase() Get the initial subsystem phase
java.lang.String	getName() Get the friendly name for this service
java.util.Collection<java.lang.String>	getPlatformAgents() Get additional platform agents for this service
ReEntranceLock	getReEntranceLock() Get the transformer re-entrance lock for this service, the transformer uses this lock to track transformer re-entrance when co-operative load and transform is performed by the service.
java.io.InputStream	getResourceAsStream(java.lang.String name) Get a resource as a stream from the appropriate classloader, this is delegated via the service so that the service can choose the correct classloader from which to obtain the resource.
java.lang.String	getSideName() Get the detected side name for this environment
java.util.Collection<ITransformer>	getTransformers() Get currently available transformers in the environment
void	init() Called at the end of subsystem boot
boolean	isClassLoaded(java.lang.String className) Check whether the specified class was already loaded by the service classloader
boolean	isValid() True if this service type is valid in the current environment
void	prepare() Called at subsystem boot
void	registerInvalidClass(java.lang.String className) Register an invalid class with the service classloader

Method Detail

getName

java.lang.String getName()

Get the friendly name for this service

isValid

boolean isValid()

True if this service type is valid in the current environment

prepare

void prepare()

Called at subsystem boot

getInitialPhase

MixinEnvironment.Phase getInitialPhase()

Get the initial subsystem phase

init

void init()

Called at the end of subsystem boot

beginPhase

void beginPhase()

Called whenever a new phase is started

checkEnv

void checkEnv(java.lang.Object bootSource)

Check whether the supplied object is a valid boot source for mixin environment

Parameters:

bootSource - boot source

getReEntranceLock

ReEntranceLock getReEntranceLock()

Get the transformer re-entrance lock for this service, the transformer uses this lock to track transformer re-entrance when co-operative load and transform is performed by the service.

getClassProvider

IClassProvider getClassProvider()

Return the class provider for this service

getBytecodeProvider

IClassBytecodeProvider getBytecodeProvider()

Return the class bytecode provider for this service

getPlatformAgents

java.util.Collection<java.lang.String> getPlatformAgents()

Get additional platform agents for this service

getResourceAsStream

java.io.InputStream getResourceAsStream(java.lang.String name)

Get a resource as a stream from the appropriate classloader, this is delegated via the service so that the service can choose the correct classloader from which to obtain the resource.

Parameters:

name - resource path

Returns:

input stream or null if resource not found

registerInvalidClass

void registerInvalidClass(java.lang.String className)

Register an invalid class with the service classloader

Parameters:

className - invalid class name

isClassLoaded

boolean isClassLoaded(java.lang.String className)

Check whether the specified class was already loaded by the service classloader

Parameters:

className - class name to check

Returns:

true if the class was already loaded

getClassRestrictions

java.lang.String getClassRestrictions(java.lang.String className)

Check whether the specified class name is subject to any restrictions in the context of this service

Parameters:

className - class name to check

Returns:

comma-separated list of restrictions, empty string if no restrictions apply

getTransformers

java.util.Collection<ITransformer> getTransformers()

Get currently available transformers in the environment

getSideName

java.lang.String getSideName()

Get the detected side name for this environment