com.ebmwebsourcing.easycommons.xml
Class XMLInputFactoryResourcePool

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

public class XMLInputFactoryResourcePool
extends java.lang.Object

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

Author:

Christophe DENEUX - EBMWebSourcing

Constructor Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLInputFactoryResourcePool

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

Allowing to instantiate a new XMLInputFactoryResourcePool containing XMLInputFactory resources.

Parameters:

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

maxPoolSize - the maximum number of XMLInputFactory 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.XMLInputFactory take()

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

Returns:

one XMLInputFactory

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.XMLInputFactory xmlInputFactory)

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

Parameters:

xmlInputFactory - The XMLInputFactory to release