org.dynalang.dynalink

Class DynamicLinkerFactory

java.lang.Object

org.dynalang.dynalink.DynamicLinkerFactory

public class DynamicLinkerFactory
extends Object

A factory class for creating DynamicLinkers. The most usual dynamic linker is a linker that is a composition of all GuardingDynamicLinkers known and pre-created by the caller as well as any automatically discovered guarding linkers and the standard fallback BeansLinker. See DynamicLinker documentation for tips on how to use this class.

Author:

Attila Szegedi

Constructor Summary

Constructors

Constructor and Description
DynamicLinkerFactory()

Method Summary

Methods

Modifier and Type	Method and Description
DynamicLinker	createLinker() Creates a new dynamic linker consisting of all the prioritized, autodiscovered, and fallback linkers.
void	setClassLoader(ClassLoader classLoader) Sets the class loader for automatic discovery of available linkers.
void	setFallbackLinkers(GuardingDynamicLinker... fallbackLinkers) Sets the fallback linkers.
void	setFallbackLinkers(List<? extends GuardingDynamicLinker> fallbackLinkers) Sets the fallback linkers.
void	setPrioritizedLinker(GuardingDynamicLinker prioritizedLinker) Sets a single prioritized linker.
void	setPrioritizedLinkers(GuardingDynamicLinker... prioritizedLinkers) Sets the prioritized linkers.
void	setPrioritizedLinkers(List<? extends GuardingDynamicLinker> prioritizedLinkers) Sets the prioritized linkers.
void	setRuntimeContextArgCount(int runtimeContextArgCount) Sets the number of arguments in the call sites that represent the stack context of the language runtime creating the linker.
void	setSyncOnRelink(boolean syncOnRelink) Sets whether the linker created by this factory will invoke MutableCallSite.syncAll(MutableCallSite[]) after a call site is relinked.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicLinkerFactory

public DynamicLinkerFactory()

Method Detail

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Sets the class loader for automatic discovery of available linkers. If not set explicitly, then the thread context class loader at the time of the constructor invocation will be used.

Parameters:

classLoader - the class loader used for the autodiscovery of available linkers.

setPrioritizedLinkers

public void setPrioritizedLinkers(List<? extends GuardingDynamicLinker> prioritizedLinkers)

Sets the prioritized linkers. Language runtimes using this framework will usually precreate at least the linker for their own language. These linkers will be consulted first in the resulting dynamic linker, before any autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the prioritized linkers, it will be ignored and the explicit prioritized instance will be used.

Parameters:

prioritizedLinkers - the list of prioritized linkers. Null can be passed to indicate no prioritized linkers (this is also the default value).

setPrioritizedLinkers

public void setPrioritizedLinkers(GuardingDynamicLinker... prioritizedLinkers)

Sets the prioritized linkers. Language runtimes using this framework will usually precreate at least the linker for their own language. These linkers will be consulted first in the resulting dynamic linker, before any autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the prioritized linkers, it will be ignored and the explicit prioritized instance will be used.

Parameters:

prioritizedLinkers - a list of prioritized linkers.

setPrioritizedLinker

public void setPrioritizedLinker(GuardingDynamicLinker prioritizedLinker)

Sets a single prioritized linker. Identical to calling setPrioritizedLinkers(List) with a single-element list.

Parameters:

prioritizedLinker - the single prioritized linker. Must not be null.

Throws:

IllegalArgumentException - if null is passed.

setFallbackLinkers

public void setFallbackLinkers(List<? extends GuardingDynamicLinker> fallbackLinkers)

Sets the fallback linkers. These linkers will be consulted last in the resulting composite linker, after any autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the fallback linkers, it will be ignored and the explicit fallback instance will be used.

Parameters:

fallbackLinkers - the list of fallback linkers. Can be empty to indicate the caller wishes to set no fallback linkers.

setFallbackLinkers

public void setFallbackLinkers(GuardingDynamicLinker... fallbackLinkers)

Sets the fallback linkers. These linkers will be consulted last in the resulting composite linker, after any autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the fallback linkers, it will be ignored and the explicit fallback instance will be used.

Parameters:

fallbackLinkers - the list of fallback linkers. Can be empty to indicate the caller wishes to set no fallback linkers. If it is left as null, the standard fallback BeansLinker will be used.

setRuntimeContextArgCount

public void setRuntimeContextArgCount(int runtimeContextArgCount)

Sets the number of arguments in the call sites that represent the stack context of the language runtime creating the linker. If the language runtime uses no context information passed on stack, then it should be zero (the default value). If it is set to nonzero value, then every dynamic call site emitted by this runtime must have the argument list of the form: (this, contextArg1[, contextArg2[, ...]], normalArgs). It is advisable to only pass one context-specific argument, though, of an easily recognizable, runtime specific type encapsulating the runtime thread local state.

Parameters:

runtimeContextArgCount - the number of language runtime context arguments in call sites.

setSyncOnRelink

public void setSyncOnRelink(boolean syncOnRelink)

Sets whether the linker created by this factory will invoke MutableCallSite.syncAll(MutableCallSite[]) after a call site is relinked. Defaults to false. You probably want to set it to true if your runtime supports multithreaded execution of dynamically linked code.

Parameters:

syncOnRelink - true for invoking sync on relink, false otherwise.

createLinker

public DynamicLinker createLinker()

Creates a new dynamic linker consisting of all the prioritized, autodiscovered, and fallback linkers.

Returns:

the new dynamic Linker