@UsesJava7 public class ForkJoinPoolFactoryBean extends Object implements FactoryBean<ForkJoinPool>, InitializingBean, DisposableBean
FactoryBeanthat builds and exposes a preconfigured
ForkJoinPool. May be used on Java 7 and 8 as well as on Java 6 with
jsr166.jaron the classpath (ideally on the VM bootstrap classpath).
For details on the ForkJoinPool API and its use with RecursiveActions, see the JDK 7 javadoc.
java.util.concurrent updates for Java 6, can be obtained
from the concurrency interest website.
|Constructor and Description|
|Modifier and Type||Method and Description|
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Invoked by a BeanFactory on destruction of a singleton.
Return an instance (possibly shared or independent) of the object managed by this factory.
Return the type of object that this FactoryBean creates, or
Is the object managed by this factory a singleton? That is, will
Specify whether to establish a local first-in-first-out scheduling mode for forked tasks that are never joined.
Set the maximum number of seconds that this ForkJoinPool is supposed to block on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down.
Set whether to expose JDK 8's 'common'
Specify the parallelism level.
Set the factory for creating new ForkJoinWorkerThreads.
Set the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks.
public void setCommonPool(boolean commonPool)
NOTE: Setting this flag to "true" effectively ignores all other
properties on this FactoryBean, reusing the shared common JDK
instead. This is a fine choice on JDK 8 but does remove the application's ability
to customize ForkJoinPool behavior, in particular the use of custom threads.
public void setParallelism(int parallelism)
public void setThreadFactory(ForkJoinPool.ForkJoinWorkerThreadFactory threadFactory)
public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)
public void setAsyncMode(boolean asyncMode)
true) may be more appropriate than the default locally stack-based mode in applications in which worker threads only process event-style asynchronous tasks. Default is
public void setAwaitTerminationSeconds(int awaitTerminationSeconds)
By default, this ForkJoinPool won't wait for the termination of tasks at all. It will continue to fully execute all ongoing tasks as well as all remaining tasks in the queue, in parallel to the rest of the container shutting down. In contrast, if you specify an await-termination period using this property, this executor will wait for the given time (max) for the termination of tasks.
Note that this feature works for the
mode as well. The underlying ForkJoinPool won't actually terminate in that
case but will wait for all tasks to terminate.
public void afterPropertiesSet()
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
public ForkJoinPool getObject()
As with a
BeanFactory, this allows support for both the
Singleton and Prototype design pattern.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding
As of Spring 2.0, FactoryBeans are allowed to return
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
public Class<?> getObjectType()
nullif not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
nullif not known at the time of the call
public boolean isSingleton()
FactoryBean.getObject()always return the same object (a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from
getObject() might get cached
by the owning BeanFactory. Hence, do not return
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning
false does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype() method. Plain
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton() implementation returns