com.neeve.util
Interface UtlPool.Item<T extends UtlPool.Item<T>>

All Known Implementing Classes:

AepApplicationExceptionEvent, AepBusBindingCreatedEvent, AepBusBindingCreateFailedEvent, AepBusBindingDestroyedEvent, AepBusBindingDownEvent, AepBusBindingOpenedEvent, AepBusBindingOpenFailedEvent, AepBusBindingOpeningEvent, AepBusBindingUpEvent, AepChannelDownEvent, AepChannelUpEvent, AepClientConnectedEvent, AepClientDisconnectedEvent, AepClientPacketEvent, AepDuplicateAcknowledgementAlertEvent, AepEngineActiveEvent, AepEngineCreatedEvent, AepEngineStartedEvent, AepEngineStopEvent, AepEngineStoppedEvent, AepEngineStoppingEvent, AepFlowCreatedEvent, AepInboundLogExceptionEvent, AepMessageTraceLoggingExceptionEvent, AepMessagingFailedEvent, AepMessagingPrestartEvent, AepMessagingStartedEvent, AepMessagingStartFailedEvent, AepOutboundLogExceptionEvent, AepOutOfOrderSendCommitCompletionAlertEvent, AepQuarantineEvent, AepResumeTransactionEvent, AepScheduleEvent, AepSendCommitCompletionEvent, AepSendEvent, AepSendExceptionEvent, AepStateCreatedEvent, AepStatsAlertEvent, AepStuckAlertEvent, AepTransactionStageEvent, AepUnhandledMessageEvent, AlertEvent, BusCongestedEvent, Event, EventBatch, EventWakeup, com.neeve.io.IOBuffer, LifecycleEvent, MessageBatchEvent, MessageBusBindingFailedEvent, MessageBusBindingFlushCompletionEvent, MessageBusBindingOpenCompletionEvent, MessageBusBindingReconnectedEvent, MessageBusBindingReconnectingEvent, MessageEvent, MessageMetadata, MessageStabilityBatchEvent, MessageStabilityEvent, PktIOBuffer, PktPacket, RawMessageViewImpl, RogLog.Entry, SrvMonAdminClientStats, SrvMonAppBusBindingInfo, SrvMonAppBusBindingStats, SrvMonAppBusChannelInfo, SrvMonAppClientInfo, SrvMonAppEngineStats, SrvMonAppEventMultiplexerFeederQueueStats, SrvMonAppEventMultiplexerStats, SrvMonAppFlowInfo, SrvMonAppInfo, SrvMonAppMessageLoggerStats, SrvMonAppStats, SrvMonAppStoreBindingICRSenderStats, SrvMonAppStoreBindingPersisterStats, SrvMonAppStoreBindingStats, SrvMonArgumentDescription, SrvMonCommandDescription, SrvMonDisruptorStats, SrvMonIntHistogram, SrvMonIntSeries, SrvMonMsgTypeStats, SrvMonOptionDescription, SrvMonPoolStats, SrvMonSysDiskStats, SrvMonSysGCCollectorStats, SrvMonSysGCStats, SrvMonSysIndividualThreadStats, SrvMonSysJITStats, SrvMonSysMemoryStats, SrvMonSysMemoryUsage, SrvMonSysStats, SrvMonSysThreadStats, SrvMonUserCounterStat, SrvMonUserGaugeStat, SrvMonUserSeriesStat, SrvMonUserStats, TriggeringMessageMetadata, UnhandledMessageEvent, UtlPlist.Element, XAbstractPooledString, XPooledString

Enclosing class:

UtlPool<T extends UtlPool.Item<T>>

public static interface UtlPool.Item<T extends UtlPool.Item<T>>

Defines a 'poolable' item.

Method Summary

UtlPool<T>	getPool() Get a pool item's pool.
T	init() Initialize an item.
T	setPool(UtlPool<T> pool) Set a pool item's pool.

Method Detail

init

T init()

Initialize an item.

This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.

Returns:

Return 'this' object for method invocation chaining.

setPool

T setPool(UtlPool<T> pool)

Set a pool item's pool.

This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.

Returns:

Return 'this' object for method invocation chaining.

getPool

UtlPool<T> getPool()

Get a pool item's pool.

This method should return the pool set using setPool(com.neeve.util.UtlPool)

Returns:

the pool set using setPool(com.neeve.util.UtlPool)