Top Description Methods
io.netty.util

public Interface ReferenceCounted

Known Direct Implementers
io.netty.util.AbstractReferenceCounted
A reference-counted object that requires explicit deallocation.

When a new ReferenceCounted is instantiated, it starts with the reference count of 1. retain() increases the reference count, and release() decreases the reference count. If the reference count is decreased to 0, the object will be deallocated explicitly, and accessing the deallocated object will usually result in an access violation.

If an object that implements ReferenceCounted is a container of other objects that implement ReferenceCounted, the contained objects will also be released via release() when the container's reference count becomes 0.

Method Summary

Modifier and TypeMethod and Description
public int
refCnt()

Returns the reference count of this object.

public boolean

Returns:

true if and only if the reference count became 0 and this object has been deallocated
release()

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

public boolean

Returns:

true if and only if the reference count became 0 and this object has been deallocated
release(int decrement)

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

public ReferenceCounted
retain()

Increases the reference count by 1.

public ReferenceCounted
retain(int increment)

Increases the reference count by the specified increment.

public ReferenceCounted
touch()

Records the current access location of this object for debugging purposes.

public ReferenceCounted
touch(Object hint)

Records the current access location of this object with an additional arbitrary information for debugging purposes.

Method Detail

refCntback to summary
public int refCnt()

Returns the reference count of this object. If 0, it means this object has been deallocated.

releaseback to summary
public boolean release()

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

releaseback to summary
public boolean release(int decrement)

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

retainback to summary
public ReferenceCounted retain()

Increases the reference count by 1.

retainback to summary
public ReferenceCounted retain(int increment)

Increases the reference count by the specified increment.

touchback to summary
public ReferenceCounted touch()

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

touchback to summary
public ReferenceCounted touch(Object hint)

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.