org.flowcomputing.commons.resgc

Class ResHolder<T,H extends ResHolder<T,H>>

java.lang.Object

org.flowcomputing.commons.resgc.ResHolder<T,H>

Type Parameters:

T - a resource type for its holder

All Implemented Interfaces:

Holder<T,H>

public class ResHolder<T,H extends ResHolder<T,H>>
extends Object
implements Holder<T,H>

hold any kind of resource and manages its life cycle.

Author:

wg

Field Summary

Fields

Modifier and Type	Field and Description
protected Collector<H,T>	m_collector
protected boolean	m_hasres
protected T	m_mres
protected Reference<H>	m_refid

Constructor Summary

Constructors

Constructor and Description
ResHolder() default constructor.
ResHolder(T mres) constructor to accept its resource.

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.

Methods inherited from class java.lang.Object

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

Field Detail

m_collector

protected Collector<H extends ResHolder<T,H>,T> m_collector

m_mres

protected T m_mres

m_hasres

protected volatile boolean m_hasres

m_refid

protected Reference<H extends ResHolder<T,H>> m_refid

Constructor Detail

ResHolder

public ResHolder()

default constructor.

ResHolder

public ResHolder(T mres)

constructor to accept its resource.

Parameters:

mres - a resource to be managed

Method Detail

get

public T get()

Description copied from interface: Holder

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

Specified by:

get in interface Holder<T,H extends ResHolder<T,H>>

Returns:

its holden resource

set

public void set(T mres)

Description copied from interface: Holder

set its holden resource.

Specified by:

set in interface Holder<T,H extends ResHolder<T,H>>

Parameters:

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

clear

public void clear()

Description copied from interface: Holder

clear its managed resource

Specified by:

clear in interface Holder<T,H extends ResHolder<T,H>>

hasResource

public boolean hasResource()

Description copied from interface: Holder

return whether it has managed resource

Specified by:

hasResource in interface Holder<T,H extends ResHolder<T,H>>

Returns:

if hold its managed resource

setCollector

public void setCollector(Collector<H,T> collector)

Description copied from interface: Holder

set collector.

Specified by:

setCollector in interface Holder<T,H extends ResHolder<T,H>>

Parameters:

collector - the collector to manage this holder.

setRefId

public void setRefId(Reference<H> rid)

Description copied from interface: Holder

set reference id.

Specified by:

setRefId in interface Holder<T,H extends ResHolder<T,H>>

Parameters:

rid - the reference id to be managed.

getRefId

public Reference<H> getRefId()

Description copied from interface: Holder

get its managed reference id.

Specified by:

getRefId in interface Holder<T,H extends ResHolder<T,H>>

Returns:

its managed reference id

cancelAutoReclaim

public void cancelAutoReclaim()

Description copied from interface: Holder

prevent resource from being reclaimed.

Specified by:

cancelAutoReclaim in interface Holder<T,H extends ResHolder<T,H>>

destroy

public void destroy()

Description copied from interface: Holder

destroy its holden resource and unregister from its collector.

Specified by:

destroy in interface Holder<T,H extends ResHolder<T,H>>