org.norther.tammi.core.pool
Interface Recyclable

All Known Subinterfaces:

Poolable

All Known Implementing Classes:

AbstractConnection, AbstractConnectorRequest, AbstractConnectorResponse, AbstractProtocolRequest, AbstractProtocolResponse, AuthenticatedRequest, BaseProtocolRequest, BeanTool, BrokerTool, ChainTool, ChannelConnection, ChartTool, ConnectorRequest, ConnectorResponse, ContentTool, ContextTool, DefaultContextToolFilter.InternalTemplateContext, DefaultFilterChain, DefaultSession, DefaultTemplateContext, DispatchedRequest, DispatchedResponse, FlowTool, FormatTool, FormTool, GlobalTool, HttpProtocolRequest, HttpProtocolResponse, HttpRelayRequest, HttpRelayResponse, HttpRMIRequest, HttpRMIResponse, HttpServletRequestDecorator, HttpServletRequestWrapper, HttpServletResponseDecorator, HttpServletResponseWrapper, InterConnection, JavaTool, LinkTool, MathTool, MediaTool, OverflowConnection, PageTool, PathTool, PoolableSupport, RecyclableSupport, ReportTool, RepositoryTool, SavedRequest, ServletConnection, ServletRequestWrapper, ServletResponseWrapper, SkinTool, SocketConnection, TaskTool, TemplateResponse, TemplateResponse, TerminalRequest, TerminalResponse, TypeTool, UserTool, VoidTool

public interface Recyclable

An interface to objects that can be pooled and recycled several times by different clients.

Author:

Ilkka Priha

Method Summary

void	dispose() Disposes the object after use.
boolean	isDisposed() Checks whether the recyclable has been disposed.
void	recycle() Recycles the object for a new client.

Method Detail

recycle

void recycle()

Recycles the object for a new client. Recycle methods with parameters must be added to implementing object and they will be automatically called by pool implementations when the object is taken from the pool for a new client. The parameters must correspond to the parameters of the constructors of the object. For new objects, constructors can call their corresponding recycle methods whenever applicable. The recycle methods must call their super.

dispose

void dispose()

Disposes the object after use. The method is called when the object is returned to its pool. The dispose method must call its super.

isDisposed

boolean isDisposed()

Checks whether the recyclable has been disposed.

Returns:

true, if the recyclable is disposed.