Pools.Pool

Added in 1.1.0

interface Pools.Pool<T : Any>

Known direct subclasses
Pools.SimplePool

Simple (non-synchronized) pool of objects.

Known indirect subclasses
Pools.SynchronizedPool

Synchronized pool of objects.


Interface for managing a pool of objects.

Parameters
<T : Any>

The pooled type.

Summary

Public functions

T?
Boolean
release(instance: T)

Release an instance to the pool.

Public functions

acquire

Added in 1.1.0
fun acquire(): T?
Returns
T?

An instance from the pool if such, null otherwise.

release

Added in 1.1.0
fun release(instance: T): Boolean

Release an instance to the pool.

Parameters
instance: T

The instance to release.

Returns
Boolean

Whether the instance was put in the pool.

Throws
kotlin.IllegalStateException

If the instance is already in the pool.