Interface ResourceLeakTracker<T>

public interface ResourceLeakTracker<T>

Method Summary

Modifier and Type	Method	Description
boolean	close(T trackedObject)	Close the leak so that ResourceLeakTracker does not warn about leaked resources.
default @Nullable Throwable	getCloseStackTraceIfAny()	Get a Throwable representing the stack trace of the original close(Object) call.
void	record()	Records the caller's current stack trace so that the ResourceLeakDetector can tell where the leaked resource was accessed lastly.
void	record(Object hint)	Records the caller's current stack trace and the specified additional arbitrary information so that the ResourceLeakDetector can tell where the leaked resource was accessed lastly.

Method Details

record

void record()

Records the caller's current stack trace so that the ResourceLeakDetector can tell where the leaked resource was accessed lastly. This method is a shortcut to record(null).

record

void record(Object hint)

Records the caller's current stack trace and the specified additional arbitrary information so that the ResourceLeakDetector can tell where the leaked resource was accessed lastly.

close

boolean close(T trackedObject)

Close the leak so that ResourceLeakTracker does not warn about leaked resources. After this method is called a leak associated with this ResourceLeakTracker should not be reported.

Returns:

true if called first time, false if called already

getCloseStackTraceIfAny

@Nullable
default @Nullable Throwable getCloseStackTraceIfAny()

Get a Throwable representing the stack trace of the original close(Object) call. If this tracker hasn't been cloesd, or close tracking isn't supported or enabled, then this method returns null.

Returns:

A throwable with the stack trace of the successful close call, or null.