PoolLogger (simple-pool 1.0 API)

java.lang.Object
- com.github.robtimus.pool.PoolLogger

```
public class PoolLogger
extends Object
```
A logger for events triggered by a Pool or PoolableObject.
Instances of this class are thread-safe.
This class needs SLF4J to be present on the class path to work. If it isn't nothing will be logged at all.

Author:

Rob Spoor

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PoolLogger.Builder
A builder for PoolLogger objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoolLogger.Builder` A builder for `PoolLogger` objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquiredObject(PoolableObject<?> object, int idleCount, int poolSize)` Called when a `PoolableObject` is acquired from a `Pool`.
`void`	`createdNonPooledObject(PoolableObject<?> object)` Called when a new `PoolableObject` has been created that will not be returned to the pool it was acquired from.
`void`	`createdObject(PoolableObject<?> object)` Called when a new `PoolableObject` has been created.
`void`	`createdPool(PoolConfig config)` Called when a `Pool` has been created.
`void`	`creatingPool(PoolConfig config)` Called when a `Pool` is being created.
`static PoolLogger.Builder`	`custom()` Returns a new builder for creating `PoolLogger` objects.
`void`	`decreasedObjectRefCount(PoolableObject<?> object, int refCount)` Called when a reference was removed from a `PoolableObject`.
`static PoolLogger`	`defaultLogger()` Returns a default `PoolLogger` object.
`void`	`drainedPool(int poolSize)` Called when a `Pool` is drained.
`void`	`failedToCreatePool(Exception exception)` Called when a `Pool` could not be created.
`void`	`increasedObjectRefCount(PoolableObject<?> object, int refCount)` Called when an additional reference was added to a `PoolableObject`.
`boolean`	`isEnabled(LogLevel level)` Returns whether or not logging at a specific level is enabled.
`static PoolLogger`	`noopLogger()` Returns a `PoolLogger` object that does not perform any actual logging.
`void`	`objectEvent(LogLevel level, PoolableObject<?> object, String message)` Called when `PoolableObject.logEvent(LogLevel, String)` is called.
`void`	`objectEvent(LogLevel level, PoolableObject<?> object, Supplier<String> messageSupplier)` Called when `PoolableObject.logEvent(LogLevel, Supplier)` is called.
`void`	`objectIdleTooLong(PoolableObject<?> object, int idleCount, int poolSize)` Called when a `PoolableObject` has been idle for too long.
`void`	`objectInvalidated(PoolableObject<?> object, int idleCount, int poolSize)` Called when a `PoolableObject` is no longer valid and has been removed from its `Pool`.
`void`	`releasedObjectResources(PoolableObject<?> object)` Called when the resources of a `PoolableObject` have been released.
`void`	`releaseObjectResourcesFailed(PoolableObject<?> object, Exception exception)` Called when an error occurs when quietly releasing the resources of a `PoolableObject`.
`void`	`releasingObjectResources(PoolableObject<?> object)` Called before the resources of a `PoolableObject` will be released.
`void`	`returnedObject(PoolableObject<?> object, int idleCount, int poolSize)` Called when a `PoolableObject` is returned to a `Pool`.
`void`	`shutDownPool()` Called when a `Pool` has shut down.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - creatingPool
```
public void creatingPool(PoolConfig config)
```
    Called when a Pool is being created.
    
    Parameters:
    
    config - The configuration for the Pool.
  - createdPool
```
public void createdPool(PoolConfig config)
```
    Called when a Pool has been created.
    
    Parameters:
    
    config - The configuration for the Pool.
  - failedToCreatePool
```
public void failedToCreatePool(Exception exception)
```
    Called when a Pool could not be created.
    
    Parameters:
    
    exception - The exception that was thrown while creating the Pool.
  - drainedPool
```
public void drainedPool(int poolSize)
```
    Called when a Pool is drained. This is like acquiring all available idle PoolableObjects in one call.
    
    Parameters:
    
    poolSize - The total pool size - the number of acquired PoolableObjects.
  - shutDownPool
```
public void shutDownPool()
```
    Called when a Pool has shut down.
  - createdObject
```
public void createdObject(PoolableObject<?> object)
```
    Called when a new PoolableObject has been created.
    
    Parameters:
    
    object - The PoolableObject.
  - createdNonPooledObject
```
public void createdNonPooledObject(PoolableObject<?> object)
```
    Called when a new PoolableObject has been created that will not be returned to the pool it was acquired from.
    
    Parameters:
    
    object - The PoolableObject.
  - increasedObjectRefCount
```
public void increasedObjectRefCount(PoolableObject<?> object,
                                    int refCount)
```
    Called when an additional reference was added to a PoolableObject.
    
    Parameters:
    
    object - The PoolableObject.
    
    refCount - The new number of references, including the PoolableObject itself.
    
    See Also:
    
    PoolableObject.addReference(Object)
  - decreasedObjectRefCount
```
public void decreasedObjectRefCount(PoolableObject<?> object,
                                    int refCount)
```
    Called when a reference was removed from a PoolableObject.
    
    Parameters:
    
    object - The PoolableObject.
    
    refCount - The new number of references, including the PoolableObject itself.
    
    See Also:
    
    PoolableObject.removeReference(Object)
  - releasingObjectResources
```
public void releasingObjectResources(PoolableObject<?> object)
```
    Called before the resources of a PoolableObject will be released.
    
    Parameters:
    
    object - The PoolableObject.
    
    See Also:
    
    PoolableObject.releaseResources()
  - releasedObjectResources
```
public void releasedObjectResources(PoolableObject<?> object)
```
    Called when the resources of a PoolableObject have been released.
    
    Parameters:
    
    object - The PoolableObject.
    
    See Also:
    
    PoolableObject.releaseResources()
  - releaseObjectResourcesFailed
```
public void releaseObjectResourcesFailed(PoolableObject<?> object,
                                         Exception exception)
```
    Called when an error occurs when quietly releasing the resources of a PoolableObject.
    
    Parameters:
    
    object - The PoolableObject.
    
    exception - The exception that was thrown while quietly releasing the resources of the PoolableObject.
    
    See Also:
    
    PoolableObject.releaseResources()
  - acquiredObject
```
public void acquiredObject(PoolableObject<?> object,
                           int idleCount,
                           int poolSize)
```
    Called when a PoolableObject is acquired from a Pool.
    
    Parameters:
    
    object - The PoolableObject.
    
    idleCount - The number of idle PoolableObjects after acquiring the PoolableObject.
    
    poolSize - The total pool size - the number of acquired and idle PoolableObjects combined.
  - returnedObject
```
public void returnedObject(PoolableObject<?> object,
                           int idleCount,
                           int poolSize)
```
    Called when a PoolableObject is returned to a Pool.
    
    Parameters:
    
    object - The PoolableObject.
    
    idleCount - The number of idle PoolableObjects after returning the PoolableObject.
    
    poolSize - The total pool size - the number of acquired and idle PoolableObjects combined.
  - objectInvalidated
```
public void objectInvalidated(PoolableObject<?> object,
                              int idleCount,
                              int poolSize)
```
    Called when a PoolableObject is no longer valid and has been removed from its Pool.
    
    Parameters:
    
    object - The PoolableObject.
    
    idleCount - The number of idle PoolableObjects after invalidating the PoolableObject.
    
    poolSize - The total pool size - the number of acquired and idle PoolableObjects combined.
    
    See Also:
    
    PoolableObject.validate()
  - objectIdleTooLong
```
public void objectIdleTooLong(PoolableObject<?> object,
                              int idleCount,
                              int poolSize)
```
    Called when a PoolableObject has been idle for too long.
    
    Parameters:
    
    object - The PoolableObject.
    
    idleCount - The number of idle PoolableObjects after invalidating the PoolableObject.
    
    poolSize - The total pool size - the number of acquired and idle PoolableObjects combined.
  - objectEvent
```
public void objectEvent(LogLevel level,
                        PoolableObject<?> object,
                        String message)
```
    Called when PoolableObject.logEvent(LogLevel, String) is called.
    
    Parameters:
    
    level - The log level to use.
    
    object - The PoolableObject.
    
    message - The event message.
  - objectEvent
```
public void objectEvent(LogLevel level,
                        PoolableObject<?> object,
                        Supplier<String> messageSupplier)
```
    Called when PoolableObject.logEvent(LogLevel, Supplier) is called.
    
    Parameters:
    
    level - The log level to use.
    
    object - The PoolableObject.
    
    messageSupplier - A supplier for the event message.
  - isEnabled
```
public boolean isEnabled(LogLevel level)
```
    Returns whether or not logging at a specific level is enabled. This can be used to perform conditional configuration, like adding logging listeners conditionally.
    
    Parameters:
    
    level - The level to check.
    
    Returns:
    
    true if logging at the given level is enabled, or false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - defaultLogger
```
public static PoolLogger defaultLogger()
```
    Returns a default PoolLogger object. This has the same configuration as an object returned by custom().build().
    
    Returns:
    
    A default PoolLogger object.
  - noopLogger
```
public static PoolLogger noopLogger()
```
    Returns a PoolLogger object that does not perform any actual logging. This can be used as default value in case no logger should be used, instead of checking for null.
    
    Returns:
    
    A PoolLogger object that does not perform any actual logging.
  - custom
```
public static PoolLogger.Builder custom()
```
    Returns a new builder for creating PoolLogger objects.
    
    Returns:
    
    A new builder for creating PoolLogger objects.

Class PoolLogger

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

creatingPool

createdPool

failedToCreatePool

drainedPool

shutDownPool

createdObject

createdNonPooledObject

increasedObjectRefCount

decreasedObjectRefCount

releasingObjectResources

releasedObjectResources

releaseObjectResourcesFailed

acquiredObject

returnedObject

objectInvalidated

objectIdleTooLong

objectEvent

objectEvent

isEnabled

toString

defaultLogger

noopLogger

custom