[POOL-66] [pool] proposed ObjectPools.borrowObject JavaDoc changes for 2.0

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.3

Environment

Operating System: All
Platform: All

• Bugzilla Id: 38660
• Assignee: Unassigned
• Reporter: Sandy McArthur (from Bugzilla import)
• Created: 16/Feb/06 02:37
• Updated: 12/Sep/10 17:42
• Resolved: 12/Sep/10 17:42

Description

Attached are the pool 2.0 changes I'd like to see to the ObjectPool and the
KeyedObjectPool interfaces for the borrowObject method. The noteworthy changes are:

Added: "Instances returned from this method will have been either newly created
with PoolableObjectFactory.makeObject or will be a previously idle object and
have been activated with PoolableObjectFactory.activateObject and then validated
with PoolableObjectFactory.validateObject."

Added: That borrowed objects can be returned to the invalidateObject method too.

Added: That client code should expect a NoSuchElementException for when the pool
has been exhaused and older versions of pool have been know to return null.