net.kuujo.catalyst.util

Class BuilderPool<T extends Builder<U>,U>

java.lang.Object

net.kuujo.catalyst.util.BuilderPool<T,U>

public class BuilderPool<T extends Builder<U>,U>
extends Object

Object builder pool.

Builders are frequently used throughout Catalyst. In order to reduce garbage collection for objects that are frequently constructed by builders, the builder pool recycles builders themselves. When a builder is acquired from a builder pool, an internal pool of existing builders will be polled for existing builders. If no builders are left in the pool, a new builder will be allocated. When Builder.close() is called the builder will be released ba

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
BuilderPool(Function<BuilderPool<T,U>,T> factory)

Method Summary

Modifier and Type	Method and Description
T	acquire() Acquires a builder from the pool.
T	acquire(U object) Acquires a builder from the pool.
void	release(T builder) Releases the given builder back to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuilderPool

public BuilderPool(Function<BuilderPool<T,U>,T> factory)

Throws:

NullPointerException - if factory is null

Method Detail

acquire

public T acquire()

Acquires a builder from the pool.

If no builders remain in the pool, a new builder will be allocated via the factory provided to this pool's constructor.

Returns:

The acquired builder.

acquire

public T acquire(U object)

Acquires a builder from the pool.

If no builders remain in the pool, a new builder will be allocated via the factory provided to this pool's constructor.

Parameters:

object - The object to build.

Returns:

The acquired builder.

release

public void release(T builder)

Releases the given builder back to the pool.

The builder will be stored in an internal Queue to be recycled on the next call to acquire().

Parameters:

builder - The builder to release back to the pool.