com.ebmwebsourcing.easycommons.xml
Class XMLOutputFactoryResourcePool

java.lang.Object
  com.ebmwebsourcing.easycommons.xml.XMLOutputFactoryResourcePool

public class XMLOutputFactoryResourcePool
extends java.lang.Object

This class represent a XMLOutputFactory pool, which provided XMLOutputFactory object as resource.

Author:

Nicolas Oddoux - EBM WebSourcing

Constructor Summary

XMLOutputFactoryResourcePool(int minPoolSize, int maxPoolSize, PoolPolicy poolPolicy)
Allowing to instantiate a new XMLOutputFactoryResourcePool containing XMLOutputFactory resources.

Method Summary

void	release(javax.xml.stream.XMLOutputFactory xmlOutputFactory) Release the specified XMLOutputFactory After putting back the XMLOutputFactory in the pool, the method onRelease() of the XMLOutputFactory resource handler is called.
javax.xml.stream.XMLOutputFactory	take() Take one unused XMLOutputFactory in the current pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLOutputFactoryResourcePool

public XMLOutputFactoryResourcePool(int minPoolSize,
                                    int maxPoolSize,
                                    PoolPolicy poolPolicy)

Allowing to instantiate a new XMLOutputFactoryResourcePool containing XMLOutputFactory resources.

Parameters:

minPoolSize - The minimum number of XMLOutputFactory instances in the pool (created at the initialization).

maxPoolSize - the maximum number of XMLOutputFactory instances in the current pool (limit of the pool). It must be greater or equals to the specified minSize. The maximum value is Integer.MAX_VALUE

poolPolicy - the PoolPolicy to adopt when the maximum size is reached. it must not be null.

Method Detail

take

public javax.xml.stream.XMLOutputFactory take()

Take one unused XMLOutputFactory in the current pool. After getting a XMLOutputFactory from the pool and before returning a XMLOutputFactory, the method onTake() of the XMLOutputFactory resource handler is called.

Returns:

one XMLOutputFactory

Throws:

PoolException - if the current thread is interrupted for the pool policy WAIT or if there is no more available resource in the pool for the pool policy REJECT

release

public final void release(javax.xml.stream.XMLOutputFactory xmlOutputFactory)

Release the specified XMLOutputFactory After putting back the XMLOutputFactory in the pool, the method onRelease() of the XMLOutputFactory resource handler is called.

Parameters:

xmlOutputFactory - The XMLOutputFactory to release