org.flowcomputing.commons.resgc

Interface Holder<T,H extends Holder<T,H>>

Type Parameters:

T - a resource type for its holder

All Known Implementing Classes:

ResHolder

public interface Holder<T,H extends Holder<T,H>>

A interface that defines a holder. it is used to hold any kind of resource and provide way to access its holden resource. In addition, it should allow its resource to be destroyed manually ahead of GC.

Author:

wg

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAutoReclaim() prevent resource from being reclaimed.
void	clear() clear its managed resource
void	destroy() destroy its holden resource and unregister from its collector.
T	get() get its holden resource.
Reference<H>	getRefId() get its managed reference id.
boolean	hasResource() return whether it has managed resource
void	set(T mres) set its holden resource.
void	setCollector(Collector<H,T> collector) set collector.
void	setRefId(Reference<H> rid) set reference id.

Method Detail

get

T get()

get its holden resource. Note that it should not be used for assignment.

Returns:

its holden resource

set

void set(T mres)

set its holden resource.

Parameters:

mres - the holder will be set to a specified resource. Note: must unregister this holder before changing its managed resource.

clear

void clear()

clear its managed resource

hasResource

boolean hasResource()

return whether it has managed resource

Returns:

if hold its managed resource

setCollector

void setCollector(Collector<H,T> collector)

set collector.

Parameters:

collector - the collector to manage this holder.

setRefId

void setRefId(Reference<H> rid)

set reference id.

Parameters:

rid - the reference id to be managed.

getRefId

Reference<H> getRefId()

get its managed reference id.

Returns:

its managed reference id

cancelAutoReclaim

void cancelAutoReclaim()

prevent resource from being reclaimed.

destroy

void destroy()

destroy its holden resource and unregister from its collector.