net.kuujo.catalyst.util

Class Builder<T>

java.lang.Object

net.kuujo.catalyst.util.Builder<T>

All Implemented Interfaces:

AutoCloseable

public abstract class Builder<T>
extends Object
implements AutoCloseable

Object builder.

This is a base interface for building objects in Catalyst.

Throughout Catalyst, builders are used to build a variety of objects. Builders are designed to be pooled and reused in order to reduce GC pressure. When build() or close() is called on a builder, the builder will be released back to the BuilderPool that created it.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
abstract T	build() Builds the object.
void	close()

Methods inherited from class java.lang.Object

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

Method Detail

build

public abstract T build()

Builds the object.

The returned object may be a new instance of the built class or a recycled instance, depending on the semantics of the builder implementation. Users should never assume that a builder allocates a new instance.

Returns:

The built object.

close

public void close()

Specified by:

close in interface AutoCloseable