Module io.netty5.common

Package io.netty5.util

Class ReferenceCountUtil

java.lang.Object

io.netty5.util.ReferenceCountUtil

public final class ReferenceCountUtil
extends Object

Collection of method to handle objects that may implement ReferenceCounted.

Method Summary

Modifier and Type	Method	Description
static boolean	isReferenceCounted(Object obj)	Tests whether the given object implements the ReferenceCounted interface.
static int	refCnt(Object msg)	Returns reference count of a ReferenceCounted object.
static boolean	release(Object msg)	Try to call ReferenceCounted.release() if the specified message implements ReferenceCounted.
static boolean	release(Object msg, int decrement)	Try to call ReferenceCounted.release(int) if the specified message implements ReferenceCounted.
static <T> T	retain(T msg)	Try to call ReferenceCounted.retain() if the specified message implements ReferenceCounted.
static <T> T	retain(T msg, int increment)	Try to call ReferenceCounted.retain(int) if the specified message implements ReferenceCounted.
static void	safeRelease(Object msg)	Try to call ReferenceCounted.release() if the specified message implements ReferenceCounted.
static void	safeRelease(Object msg, int decrement)	Try to call ReferenceCounted.release(int) if the specified message implements ReferenceCounted.
static <T> T	touch(T msg)	Tries to call ReferenceCounted.touch() if the specified message implements ReferenceCounted.
static <T> T	touch(T msg, Object hint)	Tries to call ReferenceCounted.touch(Object) if the specified message implements ReferenceCounted.

Methods inherited from class java.lang.Object

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

Method Detail

isReferenceCounted

public static boolean isReferenceCounted(Object obj)

Tests whether the given object implements the ReferenceCounted interface.

Parameters:

obj - The object to test.

Returns:

true if the given object is reference counted.

retain

public static <T> T retain(T msg)

Try to call ReferenceCounted.retain() if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

retain

public static <T> T retain(T msg,
                           int increment)

Try to call ReferenceCounted.retain(int) if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

touch

public static <T> T touch(T msg)

Tries to call ReferenceCounted.touch() if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

touch

public static <T> T touch(T msg,
                          Object hint)

Tries to call ReferenceCounted.touch(Object) if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

release

public static boolean release(Object msg)

Try to call ReferenceCounted.release() if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

release

public static boolean release(Object msg,
                              int decrement)

Try to call ReferenceCounted.release(int) if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing.

safeRelease

public static void safeRelease(Object msg)

Try to call ReferenceCounted.release() if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing. Unlike release(Object) this method catches an exception raised by ReferenceCounted.release() and logs it, rather than rethrowing it to the caller. It is usually recommended to use release(Object) instead, unless you absolutely need to swallow an exception.

safeRelease

public static void safeRelease(Object msg,
                               int decrement)

Try to call ReferenceCounted.release(int) if the specified message implements ReferenceCounted. If the specified message doesn't implement ReferenceCounted, this method does nothing. Unlike release(Object) this method catches an exception raised by ReferenceCounted.release(int) and logs it, rather than rethrowing it to the caller. It is usually recommended to use release(Object, int) instead, unless you absolutely need to swallow an exception.

refCnt

public static int refCnt(Object msg)

Returns reference count of a ReferenceCounted object. If object is not type of ReferenceCounted, -1 is returned.