org.apache.commons.io.input

Class ByteBufferCleaner

java.lang.Object

org.apache.commons.io.input.ByteBufferCleaner

final class ByteBufferCleaner
extends java.lang.Object

Cleans a direct ByteBuffer. Without manual intervention, direct ByteBuffers will be cleaned eventually upon garbage collection. However, this should not be relied upon since it may not occur in a timely fashion - especially since off heap ByeBuffers don't put pressure on the garbage collector.

Warning: Do not attempt to use a direct ByteBuffer that has been cleaned or bad things will happen. Don't use this class unless you can ensure that the cleaned buffer will not be accessed anymore.

See JDK-4724038

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	ByteBufferCleaner.Cleaner
private static class	ByteBufferCleaner.Java8Cleaner
private static class	ByteBufferCleaner.Java9Cleaner

Field Summary

Fields

Modifier and Type	Field and Description
private static ByteBufferCleaner.Cleaner	INSTANCE

Constructor Summary

Constructors

Constructor and Description
ByteBufferCleaner()

Method Summary

Modifier and Type	Method and Description
(package private) static void	clean(java.nio.ByteBuffer buffer) Releases memory held by the given ByteBuffer.
private static ByteBufferCleaner.Cleaner	getCleaner()
(package private) static boolean	isSupported() Tests if were able to load a suitable cleaner for the current JVM.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static final ByteBufferCleaner.Cleaner INSTANCE

Constructor Detail

ByteBufferCleaner

ByteBufferCleaner()

Method Detail

clean

static void clean(java.nio.ByteBuffer buffer)

Releases memory held by the given ByteBuffer.

Parameters:

buffer - to release.

Throws:

java.lang.IllegalStateException - on internal failure.

getCleaner

private static ByteBufferCleaner.Cleaner getCleaner()

isSupported

static boolean isSupported()

Tests if were able to load a suitable cleaner for the current JVM. Attempting to call ByteBufferCleaner#clean(ByteBuffer) when this method returns false will result in an exception.

Returns:

true if cleaning is supported, false otherwise.